Resume Subscription
Reactivates a paused subscription, returning it to the status it was billing under.
status back to the status it was billing under — ACTIVE, or TRIALING if it is still inside a trial phase.
You can also send reason, an optional free-form string of at most 255 characters, stored on the subscription’s reason field. It overwrites whatever reason a preceding pause recorded.
billing_cycle_behavior is an optional field on this call. It decides what happens to the billing anchor — the date in billing_cycles.next_at — when the subscription resumes:KEEP— the original billing date is preserved. If it fell due while the subscription was paused, it advances by whole billing periods until it is in the future.RESTART— the cycle re-anchors to the moment of the resume, plus the subscription’s frequency.
billing_cycle_behavior was stored on the pause — set explicitly there, or recorded as KEEP by default. An explicit value on this call always wins over what the pause stored. A subscription paused before this feature was enabled for your organization has nothing stored, and a bodyless resume on one of those keeps the pre-existing default instead: a billing date still in the future is left untouched, and one that already passed moves one billing period from the resume.No charge is issued during the call under any of these. billing_cycle_behavior is write-only — it is accepted on the request and never echoed in any response.billing_cycle_behavior is available to organizations enabled for it; contact Yuno. For an organization that is not yet enabled, sending the field returns 400 — "billing_cycle_behavior is not enabled for this organization."KEEP and RESTART compared
A subscription with a future billing anchor is resumed with each value:RESTART moves billing_cycles.next_at one month out and stamps frequency.monthly_billing_day to 15, on both the engine-direct and the merchant chain. A subscription that already declares a monthly_billing_day keeps it: RESTART re-anchors the date but does not move the day it falls on.
frequency.monthly_billing_day, RESTART sets that field to the day of the restart, and every future renewal reads it. A subscription that already declares a billing day keeps it: the date does not move to the restart day, only the time of day is re-anchored. frequency.monthly_billing_day is returned on the subscription object, so the value a restart settled on can be read back from any subscription response.The same rule applies to a RESTART on Update Subscription — it is one rule, on both endpoints.subscription.resume webhook fires once, carrying resume_reason: MERCHANT for a resume you call yourself.
Errors
Authorizations
Body
KEEP (default when omitted): the original anchor is walked forward by whole periods it missed during the pause. RESTART: re-anchors the next charge to now, plus the subscription's frequency (monthly-billing-day rule as on Update). On a pause that stored its own billing_cycle_behavior (set at the pause call), omitting this field applies the behaviour stored on the pause; an explicit value here always wins. Write-only: never echoed in any response.
KEEP, RESTART "KEEP"
Response
200
Start of the billing period the subscription is currently in, one cadence before current_period_end. Inside a trial or any other plan phase it follows that phase's cadence. A terminal subscription (CANCELED or COMPLETED) keeps its final window rather than going null. Null only for a subscription with no recurring cadence. Always returned together with current_period_end.
"2023-01-16T20:00:00.912480Z"
The retry policy applied when a recurring charge is declined. See Retries.
The optional order enrichment sent at creation, echoed back. See The Subscription Object for its full shape.
The linked plan's phase definitions, as the plan declares them — including the terminal REGULAR phase. Only present on plan-linked subscriptions whose plan has phases. This is the plan's own ladder, not this subscriber's snapshot: for what was pinned for this subscription at creation, use billing_phases.
When the phase named by current_phase hands over to the next one — for a subscription in its trial, when it switches to the regular price. End of the last billing period the phase covers, so on the final period of a trial it equals current_period_end. Null for a subscription with no plan and for one that already left the phase ladder.
"2023-03-16T20:00:00.786342Z"
Only present on plan-linked subscriptions whose plan has phases. Contains the leading TRIAL phases only, snapshotted at creation — the terminal REGULAR phase is never included, since its price isn't pinned and instead resolves from the plan at every billing. current_phase: "REGULAR" is how you know the ladder is exhausted.