Specifies the type of order. An order may be a subscription or a one-time purchase.

Customer resource ID.

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Item details.

ID of the order.

Date and time when the renewal reminder event triggers.

Number of triggered renewal reminder events.

Date and time when the trial reminder event triggers.

Number of triggered trial reminder events.

Date and time when the abandon order reminder event triggers.

Number of abandon order reminder events that are triggered.

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Status of the subscription service. A subscription starts in the pending status, and becomes active when the service period begins.

Specifies if the subscription is currently in a trial period.

Trial details. To use plan defaults do not send the trial key, or send a null value.

Specifies if a subscription ends after a trial period. If this value is true, recurring settings are ignored.

Shifts issue time and due time of invoices for this subscription.

This setting overrides plan settings. To use plan settings, set this value to null.

To use multiple plans in one subscription, all plans must have the same billing period, this property enables the customer to subscribe to different plans.

Recurring interval to override plan settings. To use plan settings, set this value to null.

To use multiple plans in one subscription, all plans must have the same recurring period length.

Specifies if payment attempts are made automatically. If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at paymentInstrumentId, or the default payment instrument on the subscription.

Date and time when the subscription starts. If this value is null, the current time is used. This value cannot be more than one service period in the past.

Date and time when the subscription ends.

Date and time when the subscription renews.

Current billing period number.

Subscription line items which queue until the next renewal (or interim) invoice is issued for the subscription.

Subtotal of line items in this subscription (signed value). If credits exceed debits, this value is a negative number.

ID of the payment instrument to use for autopay. If this value is not provided, or if the payment instrument is inactive, the customer's default payment instrument is used.

Billing status of the most recent invoice. This value may help you to determine if you should change the service status of the service, such as suspending the service.

Currency of the order.

ID of the initial invoice.

ID of the most recently issued invoice. The invoice might not be paid yet.

Delivery address of the order.

Billing address of the order.

Date and time when the order is activated.

Date and time when the order is voided.

Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, a pending order TTL setting is used to calculate the value.

Purchase order number displayed on the issued invoices.

Shipping settings.

Notes for the customer displayed on the order invoice.

Specifies who initiated the cancellation.

Category of the cancellation.

Description of the cancellation reason in free form.

Number of times the order data has been modified.

The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

Risk metadata. If this value is null, this field uses risk metadata that is captured when creating the payment token.

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

Date and time which is set automatically when the resource is created.

Date and time which updates automatically when the resource is updated.

Related links.

ID of the paused subscription.

ID of the subscription pause.

Status of the subscription pause.

Specifies who initiated the pause.

Description of the pause reason in free form.

Date when the service period pauses.

This time should be later than the current time. If this time is earlier then the current time, the current time is used.

If this field is omitted, this value defaults to the current time.

Time when the pause ends and the subscription resumes billing.

To resume a subscription from this point in time, use the current time or an earlier time. If endTime is earlier then the current time, the current time is used. If this field is empty, the subscription is indefinitely paused.

Amount of time between the pause end time and the renewal time in ISO-8601 durations format. By default, this value is computed as the time between the pause and the renewal.

Example: A $30 per month subscription on a 30-day month is paused on day 20 of the subscription. There are 10 unused days on the subscription. Therefore, the subscription renews in 10 days after it is resumed. The upcoming invoice does not change the amount for the invoiced period, it remains at $30. If the subscription uses a billing anchor, the renewal time after a pause shift behaves as though the renewal time is moved forward by an Order API operation, and the billing anchor is ignored for that period.

For more information, see Service period anchor, billing timing, and invoice time shift.

Date and time which is set automatically when the resource is created.

Date and time which updates automatically when the resource is updated.