latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs

stripe-subscriptions

Cancel Subscription

Cancel a Stripe subscription immediately, at period end, or on a custom date.

Optionally issues a refund and converts the linked CAMS plan to a $0 plan.

post/api/v1/admin/stripe-subscriptions/{subscription_id}/cancel

subscription_idstring required

cancel_when'immediately' | 'end_of_period' | 'custom_date' required

cancel_atstring date-time nullable

refund'none' | 'last_payment' | 'prorated'

mode'cancel_only' | 'cancel_and_convert'

convert_starts_atstring date-time nullable

convert_plan_namestring nullable

Successful Response

idstring required

statusstring required

cancel_atinteger nullable

canceled_atinteger nullable

cancel_at_period_endboolean

current_period_endinteger nullable

refund_status'not_requested' | 'succeeded' | 'failed' | 'no_payment_intent'

refund_errorstring nullable

plan_conversion_status'not_applicable' | 'succeeded' | 'failed'

plan_conversion_errorstring nullable