Get Voucher

Retrieve a single voucher by ID

Authorization · string · required

Bearer token with marketing:read scope

id · string · required

The voucher ID

Response

Returns the full voucher object.

Request

curl -X GET "https://api.voyantcloud.com/v1/vouchers/voucher_abc123" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "id": "voucher_abc123",
    "workspaceId": "ws_xyz",
    "code": "GC1A2B3C4D",
    "type": "gift_card",
    "status": "active",
    "customerId": null,
    "initialBalanceMinor": 10000,
    "currentBalanceMinor": 7500,
    "currency": "EUR",
    "expiresAt": "2025-12-31T23:59:59Z",
    "isTransferable": true,
    "sourceType": "purchase",
    "sourceId": "order_123",
    "lastUsedAt": "2024-07-15T10:30:00Z",
    "metadata": null,
    "createdAt": "2024-01-15T09:00:00Z",
    "updatedAt": "2024-07-15T10:30:00Z"
  }
}

Errors

Status	Error	Description
404	Voucher not found	No voucher exists with the given ID