| Field | Type | Required | Description |
|---|---|---|---|
order_id |
str | ✔️ | N/A |
reason |
models.RefundReason | ✔️ | N/A |
amount |
int | ✔️ | N/A |
metadata |
Dict[str, models.RefundCreateMetadata] | ➖ | 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 boolean You can store up to 50 key-value pairs. |
comment |
OptionalNullable[str] | ➖ | An internal comment about the refund. |
revoke_benefits |
Optional[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. |