Gift Card Properties

nameTypeDescription
idstringThe ID of the gift card.
last_charactersstringThe last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved.
balancestringThe balance of the gift card.
initial_valuestringThe initial value of the gift card when it was created.
notestringAn optional note that a merchant can attach to the gift card that isn't visible to customers.
expires_onstringThe date and time (ISO-8601 format) when the gift card expires. Returns null if the gift card doesn't have an expiration date, e.g. 2022-11-01T00:00:00Z
disabled_atstringThe date and time (ISO-8601 format) when the gift card was disabled. Returns null if the gift card is enabled, e.g. 2022-11-01T00:00:00Z
enabledboolWhether the gift card is enabled.
created_atstringThe date and time (ISO-8601 format) when the gift card was created, e.g. 2022-11-01T00:00:00Z
updated_atstringThe date and time (ISO-8601 format) when the gift card was last modified, e.g. 2022-11-01T00:00:00Z
statusstringThe status of gift card: enable, disable, expired
currencystringThe currency of the gift card.
line_item_idstringThe ID of the line item that initiated the creation of this gift card, if it was created by an order.
order_idstringThe ID of the order that initiated the creation of this gift card, if it was created by an order.
user_idstringThe ID of the user that issued the gift card, if it was issued by a user.
template_suffixstringThe suffix of the Liquid template that's used to render the gift card online.
codestringThe gift card code, which is a string of alphanumeric characters. For security reasons, this is available only upon creation of the gift card. (minimum: 8 characters, maximum: 20 characters)
customer_idstringThe ID of the customer associated with this gift card.