create subscription
This block is part of the stripe group and was last modified in core v15.0.0.
create subscription v15.0.0 Starts recurring billing for a customer who already has a payment method on file. To collect the card and subscribe in one step, use create checkout in subscription mode instead.
- flow
flow - connection required
stripeconnection - customer id required
value - price id
valueprice_… : the plan to subscribe to. Create Prices in the Stripe dashboard.
- quantity
numberSeats, units. Default 1.
- items
array<object>Full Stripe items for a multi-plan subscription, e.g.
[{"price":"price_1","quantity":2}]. Wins over price id. - payment method id
valuepm_… : which saved method to bill. Defaults to the customer's default.
- trial days
numberFree days before the first charge.
- coupon
valueA coupon id to apply.
- allow incomplete
booleanCreate the subscription even if the first charge fails, leaving it
incomplete. Without this a declined card fails the whole call and no subscription exists to chase. - 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.
subscribe |
recurring |
start subscription |
billing |
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