Skip to main content
POST
Cancel Order

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Path Parameters

id
string
required

Resource ID

Body

application/json
reason
string

Response

200 - application/json

Success

id
string
number
integer
status
enum<string>
Available options:
draft,
pending,
confirmed,
processing,
completed,
cancelled
payment_status
enum<string>
Available options:
unpaid,
awaiting_payment,
partially_paid,
paid,
partially_refunded,
refunded
fulfillment_status
enum<string>
Available options:
unfulfilled,
partially_fulfilled,
fulfilled,
returned
customer_id
string | null
email
string
shipping_address
object
billing_address
object
lines
object[]
subtotal
object
discount_total
object
shipping_total
object
tax_total
object
total
object
refunded_total
object
applied_discounts
object[]
shipping_method_name
string
note
string
payments
object[]
fulfillments
object[]
refunds
object[]
metadata
object
created_at
string<date-time>
cancelled_at
string<date-time> | null
completed_at
string<date-time> | null