Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
mutation RefundPayment($id: ID!, $input: RefundPaymentInput!) {
refundPayment(id: $id, input: $input) {
id
object
status
livemode
created
updated
payment
amount {
amount
currency
}
reason
}
}
{
"id": "rf_1a2B3c",
"input": {
"amount": {
"amount": 1299,
"currency": "usd"
}
}
}
{
"data": {
"refundPayment": {
"id": "rf_1a2B3c",
"object": "refund",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"payment": "example",
"amount": {
"amount": 1299,
"currency": "usd"
},
"reason": "example"
}
}
}
Refund a payment
mutation RefundPayment($id: ID!, $input: RefundPaymentInput!) {
refundPayment(id: $id, input: $input) {
id
object
status
livemode
created
updated
payment
amount {
amount
currency
}
reason
}
}
{
"id": "rf_1a2B3c",
"input": {
"amount": {
"amount": 1299,
"currency": "usd"
}
}
}
{
"data": {
"refundPayment": {
"id": "rf_1a2B3c",
"object": "refund",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"payment": "example",
"amount": {
"amount": 1299,
"currency": "usd"
},
"reason": "example"
}
}
}
mutation · Module: Billing · Requires billing:write · Idempotency-Key header required
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
input | RefundPaymentInput | The fields for this operation. |
RefundPaymentInput fields| Field | Type |
|---|---|
amount | MoneyInput |
Refund!
| Field | Type |
|---|---|
id | String! |
object | RefundObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
payment | String! |
amount | Money! |
status | RefundStatus! |
reason | String |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation RefundPayment($id: ID!, $input: RefundPaymentInput!) {
refundPayment(id: $id, input: $input) {
id
object
status
livemode
created
updated
payment
amount {
amount
currency
}
reason
}
}
{
"id": "rf_1a2B3c",
"input": {
"amount": {
"amount": 1299,
"currency": "usd"
}
}
}
{
"data": {
"refundPayment": {
"id": "rf_1a2B3c",
"object": "refund",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"payment": "example",
"amount": {
"amount": 1299,
"currency": "usd"
},
"reason": "example"
}
}
}