Resources
Voucher
A login sold to a customer
Fields
idstringExample:"vch_Zx81kQ0pLm"
statusone of active, expired, failed, supersededExample:"active"
usernamestringThe login name. The password is never available
Example:"ada-4821"
sourceone of purchase, generatedHow it was issued: "purchase" for a sale through the platform, "generated" for a code the business printed and sold itself
Example:"purchase"
customerUidstringnullableNull when source is "generated"
Example:"u_9fK2mP7qR1"
customerEmailstringnullableNull when source is "generated"
Example:"ada@example.com"
planIdstringExample:"pln_8Hq2LmZ0aB3c"
planNamestringExample:"Daily 5GB"
locationIdstringExample:"loc_3cD4eF5gH6"
durationstringExample:"1 day"
dataLimitstringnullableExample:"5GB"
renewalOfstringnullableThe voucher this renewal took over from
Example:null
paymentReferencestringnullableNull when source is "generated"
Example:"hs_1761818400000_0123456789abcdef"
createdAtstringnullableISO 8601 time, UTC. When it was sold, or for a generated code, when it was first used
Example:"2026-10-30T10:00:00.000Z"
expiresAtstringnullableNull until the customer first logs in
Example:"2026-10-31T10:05:00.000Z"
1{2 "id": "vch_Zx81kQ0pLm",3 "status": "active",4 "username": "ada-4821",5 "source": "purchase",6 "customerUid": "u_9fK2mP7qR1",7 "customerEmail": "ada@example.com",8 "planId": "pln_8Hq2LmZ0aB3c",9 "planName": "Daily 5GB",10 "locationId": "loc_3cD4eF5gH6",11 "duration": "1 day",12 "dataLimit": "5GB",13 "renewalOf": null,14 "paymentReference": "hs_1761818400000_0123456789abcdef",15 "createdAt": "2026-10-30T10:00:00.000Z",16 "expiresAt": "2026-10-31T10:05:00.000Z"17}