struct

Polar::Models::RefundCreate

Inherits JSON::Serializable < Struct < Value < Object

Model representing a RefundCreate

This struct is auto-generated from the Polar.sh OpenAPI specification. It uses JSON::Serializable for automatic JSON parsing and serialization.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

amount

Amount to refund in cents. Minimum is 1.

Source
comment

An internal comment about the refund.

Source
metadata

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.

Source
order_id
Source
reason
Source
revoke_benefits

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.

Source