Order resource - Developer documentation

The Order object is created each time a subscription is billed or fulfilled, capturing the complete details of that transaction. Orders contain information about the products or services being delivered, pricing, discounts applied, shipping details, and payment status.

Search query fields

Field	Description	Type
id	The subscription identifier (accepts up to 20 subscription IDs)	string

Reference

string

required

Minimum string length: 1

createdAt

string<date-time>

required

placedAt

null | string<date-time>

required

currencyCode

string

required

Required string length: 3

type

required

Available options:

checkout

paymentStatus

required

Available options:

paid

subtotal

null | number

required

Required range: x >= 0

shipping

null | number

required

Required range: x >= 0

totalPrice

null | number

required

Required range: x >= 0

taxesAmount

null | number

required

Required range: x >= 0

taxesIncluded

null | boolean

required

items

OrderItem · object[]

required

Minimum array length: 1

Show child attributes

items.id

string

required

Minimum string length: 1

items.title

string

required

Minimum string length: 1

items.subtitle

null | string

required

items.quantity

integer

required

Required range: x >= 1

items.unitPrice

number

required

Required range: x >= 0

items.totalPrice

number

required

Required range: x >= 0

items.productId

null | string

required

Minimum string length: 1

items.variantId

null | string

required

Minimum string length: 1

items.sku

null | string

required

items.variantImage

object

required

Show child attributes

items.variantImage.url

null | string<uri>

required

items.variantImage.altText

null | string

required

items.subscriptionLineId

null | string

required

Minimum string length: 1

items.requiresShipping

boolean

required

items.taxable

boolean

required

items.customAttributes

object[]

required

Show child attributes

items.customAttributes.key

string

required

Minimum string length: 1

items.customAttributes.value

string

required

items.sellingPlanId

null | string

required

Minimum string length: 1

items.sellingPlanName

null | string

required

discounts

OrderDiscount · object[]

required

Show child attributes

discounts.id

string

required

Minimum string length: 1

discounts.title

null | string

required

discounts.type

required

Available options:

Code

discounts.target

required

Available options:

Line

discounts.value

object

required

Option 1
Option 2

Show child attributes

discounts.value.type

enum<string>

required

Available options:

Percentage

discounts.value.percentage

number

required

Required range: 0 <= x <= 100

discounts.entitledItems

object

required

Option 1
Option 2

Show child attributes

discounts.entitledItems.all

enum<boolean>

required

Available options:

true,

false

discounts.subscriptionDiscountId

null | string

required

Minimum string length: 1

deliveryMethod

OrderDeliveryMethod · object

required

OrderDeliveryMethod
OrderDeliveryMethod
OrderDeliveryMethod

Show child attributes

deliveryMethod.type

enum<string>

required

Available options:

Shipping

deliveryMethod.address

Address · object

required

Show child attributes

deliveryMethod.address.firstName

null | string

required

Customer's first name.

Minimum string length: 1

deliveryMethod.address.lastName

null | string

required

Customer's last name.

Minimum string length: 1

deliveryMethod.address.address1

null | string

required

Primary street address.

Minimum string length: 1

deliveryMethod.address.address2

null | string

required

Additional address information (apartment, suite, etc.)

Minimum string length: 1

deliveryMethod.address.zip

null | string

required

Postal/ZIP code.

Minimum string length: 1

deliveryMethod.address.city

null | string

required

City name.

Minimum string length: 1

deliveryMethod.address.country

null | string

required

Full country name.

Minimum string length: 1

deliveryMethod.address.countryCode

null | string

required

Two-letter country code (ISO 3166-1).

Required string length: 2

deliveryMethod.address.provinceCode

null | string

required

Province/state code.

Minimum string length: 1

deliveryMethod.address.province

null | string

required

Full province/state name.

Minimum string length: 1

deliveryMethod.address.phone

null | string

required

Contact phone number.

Minimum string length: 1

deliveryMethod.address.company

null | string

required

Company name.

Minimum string length: 1

paymentMethod

OrderPaymentMethod · object

required

Show child attributes

paymentMethod.id

string

required

Minimum string length: 1

paymentMethod.type

required

Available options:

CreditCard

paymentMethod.details

object

required

Show child attributes

paymentMethod.details.brand

string

required

Minimum string length: 1

paymentMethod.details.lastDigits

string

required

Minimum string length: 1

paymentMethod.details.maskedNumber

string

required

Minimum string length: 1

paymentMethod.details.expiryMonth

integer

required

Required range: 1 <= x <= 12

paymentMethod.details.expiryYear

integer

required

Required range: x >= 2000

paymentMethod.details.name

string

required

Minimum string length: 1

note

null | string

required

customAttributes

object[]

required

Show child attributes

customAttributes.key

string

required

Minimum string length: 1

customAttributes.value

string

required

subscriptionIds

string[]

required

Minimum string length: 1

Core Resources

​Search query fields

​Reference

Search query fields

Reference