update subscription
This block is part of the stripe group and was last modified in core v15.0.0.
update subscription v15.0.0 Upgrades, downgrades or re-quantities a subscription. proration behaviour decides what happens to the part of the term already paid for: create_prorations credits the unused time and bills the new plan pro rata on the next invoice, always_invoice bills it straight away, none leaves the customer on the old amount until the term ends. Changing the plan needs the subscription item's id, which this block looks up for you when you give a price id.
- flow
flow - connection required
stripeconnection - subscription id required
value - price id
valueThe plan to move to. Applies to the first subscription item : for a multi-plan subscription use
items. - quantity
numberNew seat or unit count.
- items
array<object>Full Stripe items, each with the item's own
id. Wins over price id and quantity. - proration behaviour
valuecreate_prorations(Stripe's default),always_invoiceornone. • Suggestions:create_prorationsalways_invoicenone - payment method id
valueChange which saved method is billed from now on.
- coupon
value - cancel at period end
booleanSet the subscription to run out. Resume subscription is what clears it again.
- meta data
object - idempotency key
valueOptional. Reusing a key makes Stripe replay the first response instead of creating a second object : wire something stable per order, like the order GUID.
- flow
flow - connection
stripeconnection - is active
conditionTrue for
activeANDtrialing: branching on status == active alone locks every trial user out. - status
valuetrialing,active,past_due,canceled,unpaid,incomplete,paused. - subscription id
value - cancels at period end
conditionTrue when the subscription is running out rather than renewing. Resume clears it.
- period end
numberUnix timestamp : when the customer's paid-for access runs out, and when the next charge falls due.
- period start
numberUnix timestamp.
- canceled at
numberUnix timestamp of when cancellation was requested. 0 when it has not been.
- trial end
numberUnix timestamp. 0 when there is no trial.
- price id
valueThe 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
valueThe invoice a credit note would be issued against.
- meta data
object - subscription
object - success
condition - error
valueStripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.
- error code
valueStripe's machine-readable code, e.g.
card_declined,resource_missing. - decline code
valueWhy the bank refused, e.g.
insufficient_funds. Only set on a declined card.
upgrade subscription |
downgrade |
change plan |
proration |
credit subscription |
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