RefundCreate
April 16, 2025 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
metadata | Dict[str, models.RefundCreateMetadata] | :heavy_minus_sign: | 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. |
order_id | str | :heavy_check_mark: | N/A |
reason | models.RefundReason | :heavy_check_mark: | N/A |
amount | int | :heavy_check_mark: | Amount to refund in cents. Minimum is 1. |
comment | OptionalNullable[str] | :heavy_minus_sign: | An internal comment about the refund. |
revoke_benefits | Optional[bool] | :heavy_minus_sign: | 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. |