v1

latestOpenAPI 3.0.02026-07-22290108.6 KB

Pay

V2/Payouts

Update a recurring payment

Update a recurring payment by cancelling it or unpausing it. When cancelling, optionally returns a transaction to decrease allowance. When unpausing, resumes execution of a paused recurring payment.

patch/v2/payouts/recurring/{id}

Path parameters

idstring required

Example:01JXYJKCAHGFTDR15F2D072ESG

The ID of the recurring payment

Headers

x-api-keystring

API key for authentication (optional if using Client ID)

x-client-idstring

Client ID for frontend authentication (optional if using API key)

Originstring

Origin header (required for Client ID auth, automatically set by browser)

Request body

action'cancel' | 'unpause' required

The action to perform on the recurring payment

Example request

{
  "action": "cancel"
}

Response

Recurring payment updated successfully