Payments

Cancel recurring payment

Stops future collections for an active SDP-custody recurring payment by submitting the Solana subscriptions cancellation transaction. A collection already in processing may still settle independently.

post/v1/payments/recurring-payments/{id}/cancel

Path parameters

idstring required

SDP recurring payment record ID.

Example:prp_example

SDP recurring payment record ID.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Recurring payment canceled

Example response

{
  "data": {
    "recurringPayment": {
      "id": "prp_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "sourceWalletId": "privy_wallet_123",
      "sourceAddress": "So11111111111111111111111111111111111111112",
      "counterpartyId": "cpty_example",
      "counterpartyAccountId": "cpa_example",
      "destinationAddress": "So11111111111111111111111111111111111111112",
      "destinationTokenAccount": "So11111111111111111111111111111111111111112",
      "amount": "100.00",
      "periodHours": 720,
      "firstCollectionAt": "2025-01-01T00:00:00.000Z",
      "nextCollectionDueAt": "2025-01-01T00:00:00.000Z",
      "planPda": "So11111111111111111111111111111111111111112",
      "subscriptionPda": "So11111111111111111111111111111111111111112",
      "subscriptionAuthorityAddress": "So11111111111111111111111111111111111111112",
      "status": "active",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 1 of the 11 revisions of this API.6

Aug 15, 20263e302bba53866See the full diff
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added

Full history