Subscription resource

Subscription represents a contract between your business and a customer.

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

id · string<uuid> · required

resource · enum<string> · required

Available options:

subscription

serial · string · required

Minimum length: 1

status · enum<string> · required

Available options:

active,

paused,

canceled,

failed,

expired,

merged

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

canceledAt · string<date-time> | null · required

customer · required

Minimum length: 1

nextBillingDate · string<date-time> | null · required

currentCycle · integer · required

Required range: x >= 0

items · SubscriptionItem · object[] · required

Minimum length: 1

Show child attributes

discounts · SubscriptionDiscount · object[] · required

Show child attributes

paymentMethod · required

currencyCode · string · required

Required string length: 3

deliveryAddress · object | null · required

Show child attributes

deliveryMethod · object | null · required

Show child attributes

deliveryPrice · number · required

Required range: x >= 0