Skip to main content
POST
cURL

Headers

X-CSRF-Token
string
required

Echoes the token from the current session. Required on every unsafe method.

Path Parameters

orderID
string<uuid>
required

Response

Order

id
string<uuid>
required
state
enum<string>
required
Available options:
draft,
pending,
paid,
fulfilled,
cancelled,
expired,
partially_refunded,
refunded
operation
string
required
phase
string
required

The combined payment and provisioning state the panel renders: what the customer is waiting for, rather than which table changed.

currency
string
required
subtotalMinor
integer<int64>
required
discountMinor
integer<int64>
required
walletMinor
integer<int64>
required
externalMinor
integer<int64>
required
paidMinor
integer<int64>
required
refundedMinor
integer<int64>
required
plan
string
required
createdAt
string<date-time>
required
subscriptionId
string
expiresAt
string<date-time>
payment
object
fulfillment
object

Provisioning progress, read from the fulfillment operation rather than carried by the client.

refunds
object[]
paymentChoices
object[]

The methods that can settle this order in its currency, each priced at what the order still owes. Present on the detail response while the order is pending and owes something, so the page can offer a method without depending on the URL the checkout redirected to. Telegram Stars appears only for a customer with a Telegram identity.

preferredProvider
string

The method the checkout recorded, while that checkout is still attached to the order.