Expiration date of the gift card in ISO-8601 format.
2025-11-01T00:00:00Z
gift_card.disabled_at
string
Timestamp when the gift card was disabled.
null
gift_card.enabled
boolean
Whether the gift card is currently enabled.
true
gift_card.created_at
string
Timestamp of when the gift card was created.
2024-05-06T10:06:04Z
gift_card.updated_at
string
Timestamp of when the gift card was last updated.
2024-05-07T02:37:20Z
gift_card.status
string
Status of the gift card (enable or disable).
enable
gift_card.currency
string
Currency in which the gift card is denominated.
USD
gift_card.line_item_id
string
ID of the line item associated with the gift card.
null
gift_card.order_id
string
ID of the order associated with the gift card.
null
gift_card.user_id
string
User ID of the creator or owner of the gift card.
null
gift_card.template_suffix
string
Suffix of the template used to render the gift card online.
null
gift_card.customer_id
string
Customer ID associated with the gift card.
8b91ccbd-37d0-4897-aac6-5082e64ca374
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "invalid line_item id"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"store is not active"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
