RefundCreate

April 16, 2025 ยท View on GitHub

Fields

FieldTypeRequiredDescription
metadataDict[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_idstr:heavy_check_mark:N/A
reasonmodels.RefundReason:heavy_check_mark:N/A
amountint:heavy_check_mark:Amount to refund in cents. Minimum is 1.
commentOptionalNullable[str]:heavy_minus_sign:An internal comment about the refund.
revoke_benefitsOptional[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.