TidePay
Subscriptions

Cancel a subscription

POST
/subscriptions/{subscriptionId}/cancel

Stops future billing. Cancelling is not deletion — the subscription, its pricing snapshot, and every payment it produced survive, because that history is what reconciliation reads. Idempotent: cancelling an already-canceled subscription succeeds. The subscriber's on-chain authorization is theirs to revoke, so resuming later may require them to re-authorize.

X-API-Key<token>

Your merchant API key, shown once at creation in the dashboard (Settings → API key).

In: header

Path Parameters

subscriptionId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/subscriptions/string/cancel"
{  "id": "string",  "status": "canceled"}