API reference

Subscriptions. 7 operations.

7 of them work. Each needs a bearer token with its scope. All operations.

Operations

POST/api/v1/subscriptions/{number}/cancelsubscriptions.cancelsubscriptions.write

Parameters

`number`path	string
`number`path	string
`Idempotency-Key`header	stringSee common parameters

Answer

SubscriptionChange

Errors: 401, 403, 404, 405, 409, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions/{number}/cancel

POST/api/v1/subscriptions/{number}/changesubscriptions.changesubscriptions.write

Parameters

`number`path	string
`number`path	string
`Idempotency-Key`header	stringSee common parameters

Request body

SubscriptionChangeRequest

Answer

SubscriptionChange

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions/{number}/change

GET/api/v1/subscriptions/{number}subscriptions.getsubscriptions.read

Parameters

`number`path	string
`number`path	string

Answer

Subscription

Errors: 401, 403, 404, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions/{number}

GET/api/v1/subscriptionssubscriptions.listsubscriptions.read

Read a page at a time: give limit (1 to 500; 100 when none is given) and after, the Next-Cursor of the page before. Follow the Link, rel next, to the rest.

Parameters

`limit`query	integerThe most subscriptions in the page: 1 to 500; 100 when the call gives no limit. The Next-Cursor and Link headers name the next page.
`after`query	stringSee common parameters

Answer

array of Subscription

Errors: 400, 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions

POST/api/v1/subscriptions/{number}/pausesubscriptions.pausesubscriptions.write

Parameters

`number`path	string
`number`path	string
`Idempotency-Key`header	stringSee common parameters

Request body

PauseRequest

Answer

SubscriptionChange

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions/{number}/pause

POST/api/v1/subscriptions/{number}/resumesubscriptions.resumesubscriptions.write

Parameters

`number`path	string
`number`path	string
`Idempotency-Key`header	stringSee common parameters

Answer

SubscriptionChange

Errors: 401, 403, 404, 405, 409, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions/{number}/resume

POST/api/v1/subscriptions/{number}/skipsubscriptions.skipsubscriptions.write

Parameters

`number`path	string
`number`path	string
`Idempotency-Key`header	stringSee common parameters

Answer

SubscriptionChange

Errors: 401, 403, 404, 405, 409, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/subscriptions/{number}/skip

Schemas 10

Address

Address is a postal address in its fields and on one line: the domain's address, which the store's own address will take when the operations give store details.

`city`required	string
`country`required	string
`country_name`required	string
`lines`required	array of string
`postal_code`required	string
`province`required	string
`suburb`required	string
`text`required	string

Buyer

Buyer is who placed an order, as the checkout took it.

`address`required	string
`billing_address`	Address
`business_name`	string
`delivery_address`required	Address
`email`required	string
`name`required	string
`phone`required	string
`region`	string
`vat_number`	string

Cadence

Cadence is how often a subscription delivers.

`id`required	string
`label`required	string

Money

Money is an amount: in minor units of its ISO 4217 currency, and as the store displays it.

`currency`required	string
`display`required	string
`minor`required	integer

PauseRequest

PauseRequest is a pause: until a date, YYYY-MM-DD in the store's time zone, from the start of that day; "" for until resumed.

untilrequired string

SavedCard

SavedCard is a card a gateway saved, as it described it.

`brand`required	string
`exp_month`required	integer
`exp_year`required	integer
`last4`required	string

Subscription

Subscription is a subscription as the owner sees it.

`account`required	string
`actions`required	array of string
`anchor`required	string (date-time)
`buyer`required	Buyer
`cadence`required	Cadence
`cadences`required	array of Cadence
`card`	SavedCard
`events`required	array of SubscriptionEvent
`gateway`required	string
`next_due`	string (date-time)
`number`required	integer
`option_values`required	array of string
`orders`required	array of integer
`periods`required	integer
`price`required	Money
`product`required	string
`quantity`required	integer
`resume_at`	string (date-time)
`sku`required	string
`status`required	string

SubscriptionChange

SubscriptionChange is a subscription as an operation left it, and whether the operation changed it.

`changed`required	boolean
`subscription`required	Subscription

SubscriptionChangeRequest

SubscriptionChangeRequest is a change of a subscription: each field set is changed, each absent kept.

`address`	string
`cadence`	string
`quantity`	integer
`sku`	string

SubscriptionEvent

SubscriptionEvent is one change of a subscription.

`actor`required	string
`at`required	string (date-time)
`reason`required	string
`status`required	string

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.