| Field | Type | Required | Description |
|---|---|---|---|
metadata |
array<string, string|int|float|bool> | ➖ | 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. |
orderId |
string | ✔️ | N/A |
reason |
Components\RefundReason | ✔️ | N/A |
amount |
int | ✔️ | Amount to refund in cents. Minimum is 1. |
comment |
?string | ➖ | An internal comment about the refund. |
revokeBenefits |
?bool | ➖ | 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. |