Stop automatic renewal using the internal subscription UUID. Paid membership access generally continues through its paid period; trial access ends immediately. Use Cancellation Options to obtain reason codes and translated labels first.
Both fields are optional. Send reason_code exactly as returned, including case. Use reason for additional feedback, especially with other. To skip, omit reason_code; none is not accepted. The API accepts 1–255 characters for reason text, while the options endpoint advertises 200 for display.
A successful response contains cancel_offers: [] for project API keys. Cancellation feedback is recorded but is not added to the subscription's REST fields. Branch on ok, status, and data.subscription_status; transition metadata can differ when a concurrent request completed the cancellation.
After a timeout or 5xx, read the subscription state before acting. A 200 or CANCELLED status confirms cancellation recorded by BotSubscription. EXPIRED does not confirm cancellation. If a provider continues charging, contact support.
Conflict reason
Next step
CANCELLATION_IN_PROGRESS
Cancellation is recorded and still completing. Read its state; do not resend.
CANCELLATION_REVIEW_REQUIRED
Contact support for review.
PROVIDER_CANCELLATION_REQUIRED
No change was made. Cancel through the payment provider.
SUBSCRIPTION_STATE_CHANGED or an unknown reason
Read the current subscription before deciding what to do.
These reasons accompany 409 CONFLICT. Shared idempotency errors have their own IDEMPOTENCY_* codes.
Path Parameters
project_idstringrequired
Project UUID.
subscription_idstringrequired
Internal subscription UUID, not a membership or payment ID.
Request Body
reasonstring
Optional feedback text from 1 to 255 characters.
reason_codestring
too_expensive, not_using_enough, missing_features, technical_problems, switching, or other. Omit for skipped feedback.