Payments

Reverses a scheduled cancellation (Roles: user)

post/payment/subscription/reactivate

Response

Success

idstring
objectstring
collection_methodstring
cancel_at_period_endboolean
canceled_atinteger
cancel_atinteger
createdinteger
current_period_endinteger
current_period_startinteger
customerstring
days_until_dueinteger
ended_atinteger
quantityinteger
start_dateinteger
statusstring
tax_percentinteger
trial_endinteger
trial_startinteger
billing_cycle_anchorinteger
latest_invoicestring
from_teamboolean
resume_requires_paymentboolean

Present (true) only while the subscription is paused and at least one billing cycle was skipped (voided) during the pause, meaning a resume will immediately charge the full plan price for a fresh cycle.

pause_started_atinteger

When the current pause was REQUESTED. Stripe records only where a pause ends (pause_collection.resumes_at), so this is stamped into subscription metadata by pauseSubscription. Audit only: the ceiling and the mid-pause email are measured from pause_billing_from, and fall back to this only when that is absent. Absent on pauses that began before the extension feature shipped.

pause_billing_frominteger

When collection actually stops, i.e. the current_period_end that was current at the moment of pausing, and the anchor the six-month extension ceiling and the mid-pause midpoint are measured from. Must be stamped at pause time: with pause_collection.behavior "void" Stripe keeps advancing the billing cycle through the pause, so current_period_end read later names a different period. Absent on pauses that began before the extension feature shipped, which are then capped from pause_started_at instead (stricter, by the length of the paid-through tail).

pause_extended_atinteger

When the current pause was extended. Present at most once per pause; while it is present the Extend control must not be offered, because extendPause refuses a second extension.

pause_can_extendboolean

Present (true) only when extendPause would accept at least one more month right now: the pause is running, has not been extended, is not scheduled to cancel, and one more month still fits under the six-month ceiling measured from pause_billing_from (or pause_started_at). Gate the Extend control on this rather than on pause_extended_at alone, which would invite a subscriber already at the ceiling to extend and then refuse them. Absent on pauses with no anchor, where the server cannot tell from Stripe alone.

Changes

Changed in 1 of the 17 revisions of this API.1