Gift card recipients
When purchasing a gift card, you might want to send it to a recipient, either via email or physically — e.g. by printing the gift card and shipping it to a friend. To do that, you can create a gift card recipient and associate it with the purchased gift card. When the gift card is redeemed, you can then associate the gift card recipient with the customer that placed the order, so that the gift card is linked to their personal information.
A gift card recipient object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The gift card recipient unique identifier |
links.self |
| The gift card recipient endpoint URL |
attributes.email |
| The gift card recipient email address |
attributes.first_name |
| The gift card recipient first name |
attributes.last_name |
| The gift card recipient last name |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
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.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. |
relationships.customer |
| The associated customer. |
meta.mode |
| The resource environment (can be one of |
