Skip to main content
PATCH
/
v2
/
payouts
/
recurring
/
{id}
Update a recurring payment
curl --request PATCH \
  --url https://api.stage.request.network/v2/payouts/recurring/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "cancel"
}'
{
  "id": "01JXYJKCAHGFTDR15F2D072ESG",
  "status": "cancelled",
  "transactions": [
    {
      "to": "0xA0b86a33E6441b8c4C8C8C8C8C8C8C8C8C8C8C8",
      "data": "0x095ea7b30000000000000000000000000363dD3ccD4f187d7033c57354CA81f998451D590000000000000000000000000000000000000000000000000000000000000000",
      "value": "0x0"
    }
  ],
  "metadata": {
    "remainingPayments": 5,
    "remainingAmount": "5000000000000000000",
    "processedPayments": 3,
    "totalPayments": 8
  }
}

Headers

​
x-api-key
string

API key for authentication (optional if using Client ID)

​
x-client-id
string

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

​
Origin
string

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

Path Parameters

​
id
string
required

The ID of the recurring payment

Example:

"01JXYJKCAHGFTDR15F2D072ESG"

Body

application/json
​
action
enum<string>
required

The action to perform on the recurring payment

Available options:
cancel,
unpause

Response

Recurring payment updated successfully

The response is of type any.

⌘I