Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

The ID of the organization.
Prefix with name= to retrieve the organization by name instead.

order_id
string
required

The ID of the order.

Query Parameters

mode
enum<string>

The output mode.

Available options:
details

Response

OK

The order object.

id
string

The ID of the order.

status
enum<string>

The status of the subscription.

Available options:
completed,
past_due,
pending,
canceled,
payment_failed_soft_decline,
payment_failed_hard_decline
owner
string<uuid>

The UUID of the owner.

address
object

The address of the user.

company
string

The company name.

vat_number
string

An identifier used in many countries for value added tax purposes.

billing_period_start
string<date-time>

The time when the billing period of the order started.

billing_period_end
string<date-time>

The time when the billing period of the order ended.

billing_period_label
object

Descriptive information about the billing cycle.

billing_period_duration
integer

The duration of the billing period of the order in seconds.

paid_on
string<date-time> | null

The time when the order was successfully charged.

total
integer

The total of the order.

total_formatted
integer

The total of the order, formatted with currency.

components
object

The components of the project

currency
string

The order currency code.

invoice_url
string

A link to the PDF invoice.

last_refreshed
string<date-time>

The time when the order was last refreshed.

invoiced
boolean

The customer is invoiced.

line_items
object[]

The line items that comprise the order.

Links to related API endpoints.

Last modified on July 31, 2026