AppsThemesSupport

Gift Card Properties

🔒

Requires gift_cards access scope.

Gift Card properties

FieldTypeDesc
idstring
codestringThe gift card code, consisting of alphanumeric characters (minimum: 8 characters, maximum: 20 characters)
initial_valuestringThe initial value of the gift card when it was created. e.g. 200.00
balancestringRemaining balance of the gift card
currencystringCurrency of the gift card
notestringAn optional note attached to the gift card, not visible to customers
expires_onstringThe expiration date of the gift card in ISO-8601 format. e.g. 2022-11-01T00:00:00Z
disabled_atstringThe date and time when the gift card was disabled
enabledboolIndicates whether the gift card is enabled or not
statusstringStatus of the gift card: enable,disable,expire
customer_idstringThe ID of the customer associated with the gift card
user_idstringThe ID of the merchant account who created the gift card
last_charactersstringThe last four characters of the gift card code
template_suffixstringThe suffix of the Liquid template used to render the gift card online
send_emailboolIndicates whether to send a notification email to the customer

Example

{
  "gift_card": {
    "id": "377026890382183978",
    "last_characters": "218p",
    "balance": "100.00",
    "initial_value": "100.00",
    "note": "note",
    "expires_on": "2022-11-01T00:00:00Z",
    "disabled_at": null,
    "enabled": true,
    "created_at": "2024-05-06T10:12:05Z",
    "updated_at": "2024-05-06T10:12:05Z",
    "status": "enable",
    "currency": "USD",
    "line_item_id": null,
    "order_id": null,
    "user_id": "cba51e16-ac53-43d8-a7a3-161c5b1ecd8e",
    "template_suffix": null,
    "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae"
  }
}