Skip to main content
POST
Pause an owned subscription

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public UUID of an owned subscription.

Body

application/json

Top-level transition fields; omit the body or send an empty object when no fields are needed.

Pause indefinitely with an empty body, or choose a future date or number of upcoming orders, never both.

next_bill_date
string<date>

Resume date after today in the subscription timezone, capped at two years for yearly plans or twelve months otherwise.

number_of_orders
integer

Upcoming cycles to skip before resuming, subject to the same future-date and horizon limits.

Required range: x >= 1
confirm_early_order
boolean

The shopper's acknowledgement that a date earlier than the scheduled one places and charges a new order. A shopper's earlier date without it is refused with 422 and meta.code early_order_confirmation_required. For a subscription paused with no date, the comparison date is the last billed date plus one plan interval.

Response

Fresh subscription detail after the transition.

One accessible subscription.

status
integer
required

HTTP response status.

data
object
required

A subscription with its billed items, shipping, payment method, discounts and bundle.

meta
object
required

Envelope metadata present on every response.