Skip to main content
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

MethodEndpointDescription
GET/v0/orders/listList and filter orders
GET/v0/orders/{orderIdOrNumber}Retrieve an order by ID or number
PATCH/v0/orders/{orderId}/updateUpdate order details
PATCH/v0/orders/{orderId}/cancelCancel an order

​
The Order object

​
object
string
Object type identifier. Always "order" for Order objects.
​
id
string
required
Unique identifier (UUID) for this order.
​
number
string
required
Human-readable order number (e.g., #ABC123DEF456). Used for customer-facing references and support.
​
status
string
required
Current order status. Possible values: PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED
​
value
integer
Total order value in the smallest currency unit (e.g., cents for USD). Defaults to 0.
​
tax
integer
Tax amount in the smallest currency unit. Defaults to 0.
​
fee
integer
Processing fee in the smallest currency unit. Defaults to 0.
​
currency
string | null
Three-letter ISO 4217 currency code (e.g., "USD", "EUR", "GBP").
​
currencyDecimals
integer | null
Number of decimal places for the currency. Used for formatting display values.
​
country
string | null
Two-letter ISO 3166-1 alpha-2 country code where the order originated.
​
totalItems
integer
Total number of items in the order. Defaults to 0.
​
createdAt
integer
Unix timestamp in milliseconds when the order was created.
​
userId
string | null
UUID of the User who placed the order.
​
user
User | null
Expanded User object with basic information about the customer.
​
lastPaymentId
string | null
UUID of the most recent Payment associated with this order.
​
lastPaymentNumber
string | null
Human-readable number of the most recent payment.
​
lastPayment
Payment | null
Expanded Payment object with details about the most recent payment.
​
subscriptionId
string | null
Identifier of the Subscription if this order is part of a recurring subscription.
​
subscription
Subscription | null
Expanded Subscription object if this order is subscription-related.

​
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