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 |
|
|
id |
| The gift card unique identifier |
links.self |
| The gift card endpoint URL |
attributes._activate |
| Send this attribute if you want to activate a gift card. |
attributes._balance_change_cents |
| 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 |
| Send this attribute if you want to deactivate a gift card. |
attributes._purchase |
| Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated. |
attributes.balance_cents |
| The gift card balance, in cents. |
attributes.balance_float |
| The gift card balance, float. |
attributes.balance_log |
| The gift card balance log. Tracks all the gift card transactions. |
attributes.balance_max_cents |
| The gift card balance max, in cents. |
attributes.balance_max_float |
| The gift card balance max, float. |
attributes.code |
| The gift card code UUID. If not set, it's automatically generated. |
attributes.created_at |
| Time at which the resource was created. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.distribute_discount |
| Indicates if redeemed gift card amount is distributed for tax calculation. |
attributes.expires_at |
| Time at which the gift card will expire. |
attributes.formatted_balance |
| The gift card balance, formatted. |
attributes.formatted_balance_max |
| The gift card balance max, formatted. |
attributes.formatted_initial_balance |
| The gift card initial balance, formatted. |
attributes.image_url |
| The URL of an image that represents the gift card. |
attributes.initial_balance_cents |
| The gift card initial balance, in cents. |
attributes.initial_balance_float |
| The gift card initial balance, float. |
attributes.metadata |
| 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 |
| Indicates if the gift card can be recharged. |
attributes.recipient_email |
| 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 |
| 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 |
| Any identifier of the third party system that defines the reference code. |
attributes.single_use |
| Indicates if the gift card can be used only one. |
attributes.status |
| The gift card status. One of 'draft' (default), 'inactive', 'active', or 'redeemed'. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.usage_log |
| The gift card usage log. Tracks all the gift card usage actions by orders. |
relationships.attachments |
| The associated attachments. |
relationships.events |
| The associated events. |
relationships.gift_card_recipient |
| The associated gift card recipient (optional). |
relationships.market |
| The associated market (optional). |
relationships.tags |
| The associated tags. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated