---
title: "Claim a gift card"
method: POST
path: "/gift_cards/claim"
tags: ["Gift Cards"]
---

# Claim a gift card

`POST /gift_cards/claim`

## Request

- Base URL: `https://api.vrio.app`
- URL: `https://api.vrio.app/gift_cards/claim`
- Auth: API key in header `X-Api-Key`

Apply a gift card to an existing subscription.

## Request body

- object
  - `gift_card_code` string, required: Gift card code to apply to the order offer.
  - `order_offer_id` integer, required: Order Offer ID to apply the gift card to.

## Response `200`

OK

- object
  - `gift_card_id` integer
  - `customer_id` integer, nullable
  - `gift_card_code` string
  - `gift_card_total` string
  - `gift_card_balance` string
  - `gift_card_active` boolean
  - `date_expire` string, date-time, nullable
  - `date_created` string, date-time
  - `created_by` integer
  - `date_modified` string, date-time
  - `modified_by` integer
  - `gift_card_notes` string, nullable

## Other responses

- `400`: Error response
- `401`: Unauthorized response
- `403`: Forbidden response
- `500`: Error response

---

[API](https://skmtc.dev/vrio/apis/selling.md) - [All operations](https://skmtc.dev/vrio/apis/selling/llms.txt) - [OpenAPI document](https://skmtc.dev/vrio/apis/selling/revisions/83eca29c6745?raw)