Order

An Order object represents a purchase transaction made by a customer. Orders are created when a customer initiates checkout and contain information about what was purchased, the total value, tax details, and the current status of the transaction. Orders can contain one or more items and are linked to Payments, Users, and optionally Subscriptions. Each order has a unique ID and a human-readable order number that can be used for customer-facing references.

Endpoints

Method	Endpoint	Description
`GET`	`/v0/orders/list`	List and filter orders
`GET`	`/v0/orders/{orderIdOrNumber}`	Retrieve an order by ID or number
`PATCH`	`/v0/orders/{orderId}/update`	Update order details
`PATCH`	`/v0/orders/{orderId}/cancel`	Cancel an order

The Order object

string

Object type identifier. Always "order" for Order objects.

string

required

Unique identifier (UUID) for this order.

string

required

Human-readable order number (e.g., #ABC123DEF456). Used for customer-facing references and support.

string

required

Current order status. Possible values: PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED

integer

Total order value in the smallest currency unit (e.g., cents for USD). Defaults to 0.

integer

Tax amount in the smallest currency unit. Defaults to 0.

integer

Processing fee in the smallest currency unit. Defaults to 0.

string | null

Three-letter ISO 4217 currency code (e.g., "USD", "EUR", "GBP").

integer | null

Number of decimal places for the currency. Used for formatting display values.

string | null

Two-letter ISO 3166-1 alpha-2 country code where the order originated.

integer

Total number of items in the order. Defaults to 0.

integer

Unix timestamp in milliseconds when the order was created.

string | null

UUID of the User who placed the order.

User | null

Expanded User object with basic information about the customer.

Show user properties

string

Always "user".

string

required

Unique identifier (UUID) for this user.

string | null

Username of the user.

string | null

UUID of the most recent Payment associated with this order.

string | null

Human-readable number of the most recent payment.

Payment | null

Expanded Payment object with details about the most recent payment.

Show lastPayment properties

string

Always "payment".

string

required

Unique identifier (UUID) for this payment.

string

required

Payment type: one_time, subscription_initial, subscription_update, subscription_interval, subscription_extra, claim_free

string

required

Human-readable payment number.

string

required

Current payment status.

string | null

Identifier of the Subscription if this order is part of a recurring subscription.

Subscription | null

Expanded Subscription object if this order is subscription-related.

Show subscription properties

string

Always "subscription".

string

required

Subscription identifier.

string

required

Subscription status: active, past_due, canceled, unpaid, incomplete, incomplete_expired, trialing, paused

Example response

{
  "status": "success",
  "data": {
    "order": {
      "object": "order",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "number": "#ABC123DEF456",
      "status": "PAID",
      "value": 2999,
      "tax": 500,
      "fee": 87,
      "currency": "USD",
      "currencyDecimals": 2,
      "country": "US",
      "totalItems": 1,
      "createdAt": 1705590000000,
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "object": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "username": "johndoe"
      },
      "lastPaymentId": "660e8400-e29b-41d4-a716-446655440001",
      "lastPaymentNumber": "#PAY123DEF456",
      "lastPayment": {
        "object": "payment",
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "type": "one_time",
        "number": "#PAY123DEF456",
        "status": "PAID"
      },
      "subscriptionId": null,
      "subscription": null
    }
  }
}

Users

Customer accounts linked to orders

Payments

Payment transactions for orders

Subscriptions

Recurring order subscriptions

Events

Webhook events for order changes

Getting Started

Customers

Commerce

Transactions

Webhooks

Endpoints

The Order object

Example response

Users

Payments

Subscriptions

Events

​Endpoints

​The Order object

​Example response

​Related resources

Users

Payments

Subscriptions

Events

Endpoints

The Order object

Example response

Related resources