Skip to main content
POST
Create Refund

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
required
amount
integer

When specifying amount directly (when lines are not provided)

restock
boolean
default:true
lines
object[]

Specify items/quantities for partial refund

Response

201 - application/json

Created

id
string
order_id
string
amount
object
reason
string
restock
boolean
status
enum<string>
Available options:
pending,
completed,
failed
lines
object[]
created_at
string<date-time>