The order subscription item object

A comprehensive list of the order subscription item resource's attributes and relationships

An order subscription item object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/order_subscription_items endpoint.

Fields

FieldTypeDescription

type

string

order_subscription_items

id

string

The order subscription item unique identifier

links.self

string

The order subscription item endpoint URL

attributes.sku_code

string

The code of the associated SKU.

attributes.bundle_code

string

The code of the associated bundle.

attributes.quantity

integer

The subscription item quantity.

attributes.unit_amount_cents

integer

The unit amount of the subscription item, in cents.

attributes.unit_amount_float

float

The unit amount of the subscription item, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.

attributes.formatted_unit_amount

string

The unit amount of the subscription item, formatted. This can be useful to display the amount with currency in you views.

attributes.total_amount_cents

integer

Calculated as unit amount x quantity amount, in cents.

attributes.total_amount_float

float

Calculated as unit amount x quantity amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.

attributes.formatted_total_amount

string

Calculated as unit amount x quantity amount, formatted. This can be useful to display the amount with currency in you views.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.order_subscription

object

The associated order subscription.

relationships.item

object

The polymorphic item associated to the subscription item. One of 'skus', 'bundles', or 'adjustments'.

relationships.sku

object

The associated sku item.

relationships.bundle

object

The associated bundle item.

relationships.adjustment

object

The associated adjustment item.

relationships.source_line_item

object

The source line item which generated the subscription item.

meta.mode

string

The resource environment (can be one of test or live)

Last updated