🔒
Requires write_gift_cards access scope. More access scope

The Disable Gift Card API disables a specific gift card using its unique ID.

This API is especially useful for:

Revoking a gift card to prevent further use.
Disabling a gift card due to security concerns or fraudulent activity.

Note: The operation updates the status field to "disable" and sets the disabled_at timestamp accordingly.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Field	Type	Required	Description	Example
`id`	string	Yes	Gift card's ID.	`377006280092433706`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"200"`	The status code of the response
`message`	string	`"success"`	The message describing the response status
`data.gift_card.id`	string	`"gc_123456"`	Unique identifier for the gift card
`data.gift_card.last_characters`	string	`"456"`	Last characters of the gift card code
`data.gift_card.balance`	string	`"100.00"`	Current balance of the gift card
`data.gift_card.initial_value`	string	`"100.00"`	The initial value of the gift card
`data.gift_card.note`	string	`"Birthday gift for John"`	Note attached to the gift card
`data.gift_card.expires_on`	string	`"2025-12-31T23:59:59Z"`	Expiration date of the gift card in ISO-8601 format
`data.gift_card.disabled_at`	string	`null`	Timestamp when the gift card was disabled (null if active)
`data.gift_card.enabled`	boolean	`true`	Whether the gift card is currently enabled
`data.gift_card.created_at`	string	`"2025-06-01T10:00:00Z"`	Timestamp of when the gift card was created
`data.gift_card.updated_at`	string	`"2025-06-01T10:00:00Z"`	Timestamp of when the gift card was last updated
`data.gift_card.status`	string	`"disable"`	Status of the gift card (enable or disable)
`data.gift_card.currency`	string	`"USD"`	Currency in which the gift card is denominated
`data.gift_card.line_item_id`	string	`"li_123"`	ID of the line item associated with the gift card
`data.gift_card.order_id`	string	`"order_456"`	ID of the order associated with the gift card
`data.gift_card.user_id`	string	`"user_789"`	User ID of the creator or owner of the gift card
`data.gift_card.template_suffix`	string	`"birthday"`	Suffix of the template used to render the gift card online
`data.gift_card.customer_id`	string	`"cust_12345"`	Customer ID associated with the gift card
`data.gift_card.code`	string	`"GIFT123456"`	The gift card code, consisting of alphanumeric characters

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message