Recurring Incentives

Delete a Recurring Incentive

Delete a Recurring Incentive, that is, a monthly paid incentive.

Internally, Remote schedules upcoming incentives. As such, when you attempt to delete a recurring incentive, Remote will ONLY delete scheduled incentives with the pending status.

Incentives payments that are already scheduled and cannot be deleted will be included in the response, in case you need to reference them.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage expenses (employment_payments)	-	Manage incentives (incentive:write)
Company-scoped access token (assertion)	Manage expenses (employment_payments)	-	Manage incentives (incentive:write)
Customer API token	Manage expenses (employment_payments)	-	Manage incentives (incentive:write)

delete/v1/incentives/recurring/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/incentives/recurring/{id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: incentive:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: incentive:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

idstring required

Recurring Incentive ID

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

Example response

{
  "data": {
    "already_scheduled_incentives": [],
    "status": "ok"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.