VRvrio
Gift Cards

Claim a gift card

Apply a gift card to an existing subscription.

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

Request body

gift_card_codestring required

Gift card code to apply to the order offer.

order_offer_idinteger required

Order Offer ID to apply the gift card to.

Response

OK

gift_card_idinteger
customer_idinteger nullable
gift_card_codestring
gift_card_totalstring
gift_card_balancestring
gift_card_activeboolean
date_expirestring date-time nullable
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger
gift_card_notesstring nullable

Example response

{
  "date_expire": "2023-04-01 00:00:00",
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.