Update Gift Card

PUT 
/openapi/2022-01/gift_cards/:id

Updates the details of a specific gift card using its unique ID.

Request

Path Parameters

id stringrequired

Gift card's ID

application/json

Body

Body

gift_card object

Gift card informations to update

expires_onstring

The date when the gift card expires. e.g. 2022-11-01T00:00:00Z

notestring

An optional note that a merchant can attach to the gift card that isn't visible to customers.

template_suffixstring

The suffix of the Liquid template that's used to render the gift card online.

Example

{
  "gift_card": {
    "expires_on": "string",
    "note": "string",
    "template_suffix": "string"
  }
}

Responses

200

200

application/json

Schema

Schema

gift_card object
idstring
Example: 377006280092433706
last_charactersstring
Example: ghjg
balancestring
Example: 100.00
initial_valuestring
Example: 100.00
notestring
Example: note
expires_onstring
Example: 2025-11-01T00:00:00Z
disabled_at
enabledboolean
Default value: true
Example: true
created_atstring
Example: 2024-05-06T10:06:04Z
updated_atstring
Example: 2024-05-07T02:37:20Z
statusstring
Example: enable
currencystring
Example: USD
line_item_id
order_id
user_id
template_suffix
customer_idstring
Example: 8b91ccbd-37d0-4897-aac6-5082e64ca374

Example

{
  "gift_card": {
    "id": "377006280092433706",
    "last_characters": "ghjg",
    "balance": "100.00",
    "initial_value": "100.00",
    "note": "note",
    "expires_on": "2025-11-01T00:00:00Z",
    "disabled_at": {},
    "enabled": true,
    "created_at": "2024-05-06T10:06:04Z",
    "updated_at": "2024-05-07T02:37:20Z",
    "status": "enable",
    "currency": "USD",
    "line_item_id": {},
    "order_id": {},
    "user_id": {},
    "template_suffix": {},
    "customer_id": "8b91ccbd-37d0-4897-aac6-5082e64ca374"
  }
}

Result

{
  "gift_card": {
    "id": "377006280092433706",
    "last_characters": "ghjg",
    "balance": "100.00",
    "initial_value": "100.00",
    "note": "note",
    "expires_on": "2025-11-01T00:00:00Z",
    "disabled_at": null,
    "enabled": true,
    "created_at": "2024-05-06T10:06:04Z",
    "updated_at": "2024-05-07T02:37:20Z",
    "status": "enable",
    "currency": "USD",
    "line_item_id": null,
    "order_id": null,
    "user_id": null,
    "template_suffix": null,
    "customer_id": "8b91ccbd-37d0-4897-aac6-5082e64ca374"
  }
}