SUQODocs
User GuideAPI ReferenceSDKs
Subscriptions

Cancel a subscription

Schedule cancellation at the end of the current billing period; the subscription stays usable until then. A subscription already cancelled or pending cancellation is returned unchanged (200), so a retry is safe. One-time purchases cannot be cancelled.

POST
/subscriptions/{id}/cancel/

Authorization

ApiKey
AuthorizationBearer <token>

API key issued to the partner, sent with the Bearer prefix — for example: Authorization: Bearer su_key_9f2c4d1ab3….

Keys minted on the live instance are prefixed su_key_ and keys minted on sandbox su_test_key_. The two instances keep separate key tables and separate hosts, so a sandbox key sent to the live host — or the reverse — answers Invalid API key. rather than falling back to the other environment.

In: header

Path Parameters

id*string

UUID of the subscription.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel/"
{  "message": "Subscription will be cancelled at the end of the current billing period."}

Retrieve a subscription GET

Return a single subscription belonging to your account.

Resume a subscription POST

Undo a scheduled cancellation and return the subscription to active. Already-active subscriptions are returned unchanged; one-time purchases cannot be resumed.