Cancel a subscription
Recurring billing for the agreement stops. Invoices for periods that have not started, with no payment that moved money or is still in progress (a declined attempt does not count), are voided (an overdue one is held from collection instead), and the charges waiting for the plan's next invoice, with the late fees no other plan of the agreement will bill, are billed at once on one invoice of their own. The cover the subscription bills (insurance or a waiver) ends on the last day an invoice still stands for, never before today in Europe/London. An unpaid invoice held from collection, for a period starting on or after the day the cancellation takes effect (`effective_date`, else today), stands for none, since that period is never provided. Another subscription's cover on the same agreement is left alone.
Recurring billing for the agreement stops. Invoices for periods that have not started, with no payment that moved money or is still in progress (a declined attempt does not count), are voided (an overdue one is held from collection instead), and the charges waiting for the plan's next invoice, with the late fees no other plan of the agreement will bill, are billed at once on one invoice of their own. The cover the subscription bills (insurance or a waiver) ends on the last day an invoice still stands for, never before today in Europe/London. An unpaid invoice held from collection, for a period starting on or after the day the cancellation takes effect (effective_date, else today), stands for none, since that period is never provided. Another subscription's cover on the same agreement is left alone.
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Path Parameters
UUIDv7 identifier of the resource.
uuidHeader Parameters
A unique key that makes this mutation safe to retry. Repeats replay the stored response; reuse with a different body returns 409 idempotency_conflict.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Optional context for a state-changing action.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "subscription", "agreement_id": "67dd069b-637c-4b8e-8d92-17a313d06fb8", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811", "status": "pending", "billing_interval": "week", "interval_count": 0, "currency": "str", "amount_minor": 0, "current_period_start": "2019-08-24", "current_period_end": "2019-08-24", "next_billing_date": "2019-08-24", "anchor_day": 0, "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a", "mandate_id": "e98a8906-c5df-4f83-89a8-e8197c5fddcb", "default_rail": "bacs_dd", "auto_collect": true, "collection_waived": true, "customer_reference": "string", "started_at": "2019-08-24T14:15:22Z", "paused_at": "2019-08-24T14:15:22Z", "cancelled_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "pending_renewal_change": { "bridge_start": "2019-08-24", "bridge_end": "2019-08-24", "new_period_start": "2019-08-24", "new_anchor_day": 0, "bridge_days": 0, "bridge_amount_minor": 0 }, "promotion": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "coupon_id": "97ffaabb-eb3d-43ed-8769-a889d53b9a3d", "code": "string", "name": "string", "discount_kind": "percent", "discount_value": 0, "periods_total": 0, "periods_applied": 0, "source": "checkout", "created_at": "2019-08-24T14:15:22Z" } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "not_found", "message": "Resource not found." }}{ "error": { "code": "conflict", "message": "The request conflicts with current resource state." }}{ "error": { "code": "validation_error", "message": "One or more fields are invalid.", "details": [ { "field": "email", "issue": "must be a valid email address" } ] }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}Cancel a reservation POST
A held reservation is released, and its customer, if it has one, is emailed. Cancelling one already cancelled returns it unchanged. One taken up or expired is refused with a 409, and so is a hold whose `held_until` has passed but which is not yet marked `expired` ("This reservation has already lapsed."): the sweep that runs every 15 minutes lapses it, sends no email, and tells an endpoint that listens through the `reservation.expired` webhook.
Cancel a pending renewal date change DELETE
Withdraws a renewal date change that has not been billed yet. The subscription carries on renewing on its current day. Once the renewal invoice has been raised the change has already happened, and this returns 409. What can be withdrawn is decided by the waiting change itself, not by the subscription's status: a change parked before the agreement was paused or fell past due can still be taken back. Fires subscription.renewal_date_change_cancelled.