The gift card object

A comprehensive list of the gift card resource's attributes and relationships

A gift card object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/gift_cards endpoint.

Fields

Field	Type	Description
type	string	gift_cards
id	string	The gift card unique identifier
links.self	string	The gift card endpoint URL
attributes._activate	boolean	Send this attribute if you want to activate a gift card.
attributes._balance_change_cents	integer	The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable).
attributes._deactivate	boolean	Send this attribute if you want to deactivate a gift card.
attributes._purchase	boolean	Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.
attributes.balance_cents	integer	The gift card balance, in cents.
attributes.balance_float	float	The gift card balance, float.
attributes.balance_log	array	The gift card balance log. Tracks all the gift card transactions.
attributes.balance_max_cents	string	The gift card balance max, in cents.
attributes.balance_max_float	float	The gift card balance max, float.
attributes.code	string	The gift card code UUID. If not set, it's automatically generated.
attributes.created_at	datetime	Time at which the resource was created.
attributes.currency_code	string	The international 3-letter currency code as defined by the ISO 4217 standard.
attributes.distribute_discount	boolean	Indicates if redeemed gift card amount is distributed for tax calculation.
attributes.expires_at	datetime	Time at which the gift card will expire.
attributes.formatted_balance	string	The gift card balance, formatted.
attributes.formatted_balance_max	string	The gift card balance max, formatted.
attributes.formatted_initial_balance	string	The gift card initial balance, formatted.
attributes.image_url	string	The URL of an image that represents the gift card.
attributes.initial_balance_cents	integer	The gift card initial balance, in cents.
attributes.initial_balance_float	float	The gift card initial balance, float.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes.rechargeable	boolean	Indicates if the gift card can be recharged.
attributes.recipient_email	string	The email address of the associated recipient. When creating or updating a gift card, this is a shortcut to find or create the associated recipient by email.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.single_use	boolean	Indicates if the gift card can be used only one.
attributes.status	string	The gift card status. One of 'draft' (default), 'inactive', 'active', or 'redeemed'.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.usage_log	object	The gift card usage log. Tracks all the gift card usage actions by orders.
relationships.attachments	array	The associated attachments.
relationships.events	array	The associated events.
relationships.gift_card_recipient	object	The associated gift card recipient (optional).
relationships.market	object	The associated market (optional).
relationships.tags	array	The associated tags.
relationships.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)