Subscription resource - Developer documentation

The Subscription object stores information and rules defining the contract between your business and a customer. It is created when a customer purchases a subscription-based product.

Search query fields

Field	Description	Type
id	The subscription identifier	string
serial	The incremental subscription number	string
status	The subscription status	string
createdAt	The date subscription was created	date
updatedAt	The last date the subscription was updated	date
nextBillingDate	The upcoming next billing date	date
canceledAt	The date subscription was cancelled	date
customer	The customer identifier	string

Reference

string

required

resource

enum<string>

required

Available options:

subscription

serial

string

required

Unique serial number that increments sequentially with each new subscription within a store.

Minimum length: 1

status

enum<string>

required

Available options:

active,

paused,

canceled,

failed,

expired

createdAt

string

required

Purchase date of the subscription.

updatedAt

string

required

Last update date of the subscription.

canceledAt

string | null

required

Cancellation date of the subscription.

customer

required

This field is expandable.

Minimum length: 1

nextBillingDate

string | null

required

The next billing date determines when the renewal process begins its billing phase. When billing succeeds, it creates one order—or multiple orders for prepaid subscriptions.

currentCycle

integer

required

The subscription's billing cycle count. It starts at 0 (before the first billing is completed), changes to 1 (after one billing is completed), and increases by 1 with each subsequent billing.

Required range: x >= 0

items

object[]

required

discounts

object[]

required

paymentMethod

required

This field is expandable.

currencyCode

string

required

The currency that applies to both item prices and delivery price.

Required string length: 3

deliveryAddress

object | null

required

deliveryMethod

object | null

required

deliveryPrice

number

required

The delivery price for the upcoming renewal.

Required range: x >= 0

Core Resources

​Search query fields

​Reference

Search query fields

Reference