GiftCard
Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.
Properties
id
stringRequiredThe gift card's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
code
stringRequiredThe unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.
value
numberRequiredThe value that the Gift Card represents.
balance
numberRequiredThe remaining value on the Gift Card.
region_id
stringRequiredThe ID of the region this gift card is available in.
The details of the region this gift card is available in.
order_id
stringRequiredThe ID of the order that the gift card was purchased in.
The details of the order that the gift card was purchased in.
is_disabled
booleanRequiredWhether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.
Default: false
ends_at
DateRequiredThe time at which the Gift Card can no longer be used.
tax_rate
null | numberRequiredThe gift card's tax rate that will be applied on calculating totals
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
Was this section helpful?