v12

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-07-0971442569.2 KB

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 date-time

CancelAt is the exact date/time when the subscription should be cancelled. Required for cancellation_type "scheduled_date"; optional for "immediate" (past dates only — backdated cancellation). For "scheduled_date", accepts both future dates (deferred cancellation) and past dates (backdated cancellation). For "immediate", accepts past/current dates only; use "scheduled_date" for future dates.

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

cancellation_type'immediate' | 'end_of_period' | 'scheduled_date'

effective_datestring date-time

messagestring

Response metadata

processed_atstring date-time

reasonstring

subscription_idstring

Basic cancellation info

total_credit_amountstring