The Gift Card Products API allows you to create and manage gift card products, which are templates that define what a purchasable gift card looks like on a site. Each product includes a name, description, image, available denominations (the monetary values buyers can choose from), and an expiration policy. When a customer purchases a gift card, an individual gift card instance is created based on the product's configuration.
With the Gift Card Products API, you can:
- Create, update, and delete gift card products.
- Retrieve and query gift card products.
- Configure preset and custom denominations for each product.
- Set expiration policies for gift card products.
To manage individual gift card instances after purchase, use the Gift Cards API.
Each gift card product must have at least one variant, which defines the denominations buyers can choose from. A product can have both types of variants at the same time.
- Preset variant: A fixed denomination with a set price and value. The price is what the buyer pays, and the value is the balance loaded onto the gift card. These can differ to support promotions. For example, you could sell a $50 gift card for $45.
- Custom variant: A range defined by a minimum and maximum amount, allowing the buyer to choose their own gift card value. For custom variants, the price always equals the value.
Gift card products support three expiration policies:
- None: Gift cards don't expire.
- Fixed: All gift cards expire on a specific date.
- Relative: Gift cards expire after a set period from the date of purchase, such as 6 months or 1 year.
- Gift card product: A template that defines a purchasable gift card's name, image, denominations, and expiration policy.
- Preset variant: A fixed denomination option with a specific price and value.
- Custom variant: A denomination option that allows buyers to choose their own amount within a defined range.
- Price: The amount a buyer pays for a gift card.
- Value: The balance loaded onto the gift card after purchase.