Dashboard
APICancellation Options | Subscription Bot API
api.botsubscription.com
GET/v1/endpoint
AuthenticationBearer
Token
Stays in this tab. Required for this endpoint — the value below is what gets sent.
Examples
curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Cancellation Options

GET/v2/projects/{project_id}/subscriptions/{subscription_id}/cancel-options

Authorization

Bearer API KeyRequired

API key access: Unrestricted project key only.

Fetch the translated reason choices before cancelling a subscription. Labels follow Accept-Language, with English as the fallback. Send the selected code as reason_code on cancellation, or omit it when the member skips feedback.

Project API keys receive offers: []. Do not expect coupon codes or a member's return discount in this response. Configure the project's coupon separately with Set Return Offer.

The response advertises reason_text_max_length: 200 for displayed feedback. The cancellation request accepts up to 255 characters; keep member-facing input within the returned display limit.

Path Parameters

project_idstringrequired

Project UUID.

subscription_idstringrequired

Internal subscription UUID, not a membership or payment ID.

Query Parameters

reason_codestring

Selected reason from the cancellation reason list; omit for skipped feedback.

See the project API authentication rules for shared request and retry behavior.

Last updated: