GiftCard

Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.

Properties

balancenumberRequired

The remaining value on the Gift Card.

codestringRequired

The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.

created_atDateRequired

The date with timezone at which the resource was created.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

ends_atDateRequired

The time at which the Gift Card can no longer be used.

idstringRequired

The gift card's ID

is_disabledbooleanRequired

Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.

Default: false

metadataRecord<string, unknown>Required

An optional key-value map with additional details

orderOrderRequired

The details of the order that the gift card was purchased in.

order_idstringRequired

The ID of the order that the gift card was purchased in.

regionRegionRequired

The details of the region this gift card is available in.

region_idstringRequired

The ID of the region this gift card is available in.

tax_ratenull | numberRequired

The gift card's tax rate that will be applied on calculating totals

updated_atDateRequired

The date with timezone at which the resource was updated.

valuenumberRequired

The value that the Gift Card represents.