v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

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.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage expenses (employment_payments)	-	Manage incentives (incentive:write)

delete/v1/incentives/recurring/{id}

Path parameters

idstring required

Recurring Incentive ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

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