Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required
Required string length: 8 - 128

Body

application/json
customerID
string<uuid>
required
planVersionID
string<uuid>
required
currency
string
required
Pattern: ^[A-Z]{3}$
operation
enum<string>
required
Available options:
purchase,
upgrade,
downgrade,
extension
promoCode
string

Response

Order created

id
string<uuid>
customerId
string<uuid>
state
enum<string>
Available options:
draft,
pending,
paid,
fulfilled,
cancelled,
expired,
partially_refunded,
refunded
operation
string
currency
string
subtotalMinor
integer<int64>
discountMinor
integer<int64>
walletMinor
integer<int64>
externalMinor
integer<int64>
paidMinor
integer<int64>
refundedMinor
integer<int64>
expiresAt
string<date-time>
createdAt
string<date-time>