Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

capture_geo_address_enabled
boolean

Whether or not to reverse-geocode the latitude and longitude captured on checkouts into a geo_address.

inherit_customer_enabled
boolean

Each order has a series of attributes inherited_billing_address, inherited_shipping_address, inherited_tax_identifier, inherited_name, inherited_phone, and inherited_email. If this is enabled, the order will inherit these attributes from the customer when they are not present on the associated checkout. This allows changes to a customers details to be reflected on past orders and statements.

The default footer that is shown on all order statements (i.e. invoices and receipts).

memo
string | null

The default memo that is shown on all order statements (i.e. invoices and receipts).

next_sequential_number
integer

Specified to change the next sequential number to be used. If changed, must be larger than the highest current sequential number.

number_prefix
string | null

The prefix that is added to all order numbers. Must be between 3-12 characters and only include letters.

number_type
string

The type of number to use for orders – one of sequential or token.

require_reusable_payment_methods
boolean
upsells_expire_after_minutes
integer

The number of minutes after an order is paid that upsells will be available for.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.