Skip to main content
POST
Pause a subscription

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

token
string
required

Subscription token, one of the manage link's subscriptions.

Query Parameters

next_bill_date
string<date>

Date billing resumes. Mutually exclusive with number_of_orders.

number_of_orders
integer

Number of orders to pause for. Mutually exclusive with next_bill_date.

Response

The subscription after the action.

One subscription after a manage action.

subscription
object
required

A subscription as a manage link shows it: what ships, when and how often. It has no customer record, address, payment method, order history or note.

meta
object
required