resume subscription

This block is part of the stripe group and was last modified in core v15.0.0.

resume subscription stripeconnection v15.0.0

Renews a subscription that was going to stop: clears cancels at period end, and lifts a pause if one is set. A subscription that has already ended cannot be resumed by anything : the block says so rather than failing obscurely, and a new subscription has to be created.

In pins 3 + flow

flow
flow
connection required
stripeconnection
subscription id required
value
idempotency key
value
Optional. Reusing a key makes Stripe replay the first response instead of creating a second object : wire something stable per order, like the order GUID.

Out pins 19 + flow

flow
flow
connection
stripeconnection
is active
condition
True for active AND trialing : branching on status == active alone locks every trial user out.
status
value
trialing, active, past_due, canceled, unpaid, incomplete, paused.
subscription id
value
cancels at period end
condition
True when the subscription is running out rather than renewing. Resume clears it.
period end
number
Unix timestamp : when the customer's paid-for access runs out, and when the next charge falls due.
period start
number
Unix timestamp.
canceled at
number
Unix timestamp of when cancellation was requested. 0 when it has not been.
trial end
number
Unix timestamp. 0 when there is no trial.
price id
value
The plan on the first item : what a single-plan subscription is subscribed to.
items
array<object>
Every subscription item, for the multi-plan case.
customer id
value
latest invoice id
value
The invoice a credit note would be issued against.
meta data
object
subscription
object
success
condition
error
value
Stripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.
error code
value
Stripe's machine-readable code, e.g. card_declined, resource_missing.
decline code
value
Why the bank refused, e.g. insufficient_funds. Only set on a declined card.

renew subscription

uncancel

reactivate

restart billing

resume

A subscription cancelled at period end has not ended yet, so it can be put back. resume subscription clears the scheduled cancellation and the customer carries on uninterrupted. It only works inside that window: once the period has actually ended there is nothing to resume and you are creating a new subscription instead.

Version history

Introduced in v15.0.0.

Service documentation

External API reference This block wraps a third-party service. Click here for the service's own documentation of the underlying endpoint.

Back to stripe Return to the main group to view all sub-groups Back to subscriptions Return to the group to view all blocks within this group