Create Refund
Create a refund.
Scopes: refunds:write
Authorizations
Body
Reason for the refund.
duplicate, fraudulent, customer_request, service_disruption, satisfaction_guarantee, other Amount to refund in cents. Minimum is 1.
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
An internal comment about the refund.
Should this refund trigger the associated customer benefits to be revoked?
Note:
Only allowed in case the order is a one-time purchase.
Subscriptions automatically revoke customer benefits once the
subscription itself is revoked, i.e fully canceled.
Response
Refund created.
Creation timestamp of the object.
"2026-01-01T00:00:00.000000Z"
Last modification timestamp of the object.
"2026-01-01T00:00:00.000000Z"
The ID of the object.
pending, succeeded, failed, canceled duplicate, fraudulent, customer_request, service_disruption, satisfaction_guarantee, dispute_prevention, other Dispute associated with a refund, in case we prevented a dispute by issuing a refund.

