Sign in
Subscriptions

Cancel subscription

Use when a customer churns or downgrades. Supports immediate or end-of-period cancellation and proration. Ideal for self-serve or support-driven cancellations.

post/subscriptions/{id}/cancel

Path parameters

idstring required

Subscription ID

Request body

cancel_atstring

CancelAt is the custom date to cancel the subscription. Required when CancellationType is "scheduled_date". Must be in the future.

cancel_immediately_inovice_policy'generate_invoice' | 'skip'
cancellation_type'immediate' | 'end_of_period' | 'scheduled_date' required
proration_behavior'create_prorations' | 'none'
reasonstring

Reason for cancellation (for audit and business intelligence)

Response

OK

cancellation_type'immediate' | 'end_of_period' | 'scheduled_date'
effective_datestring
messagestring

Response metadata

processed_atstring
reasonstring
status'active' | 'paused' | 'cancelled' | 'incomplete' | 'trialing' | 'draft'
subscription_idstring

Basic cancellation info

total_credit_amountstring

Changes