Vouchers
List vouchers
/vouchersneedsvouchers:readNewest first, paged by cursor.
Needs the vouchers:read permission.
Query parameters
limitinteger, 1 to 50, default 25Results per page, 1 to 50
Example:25
cursorstringThe nextCursor from the previous page
Example:"1761818400000_vch_Zx81kQ0pLm"
statusone of active, expired, failed, supersededOnly vouchers in this state
Example:"active"
fromstringCreated on or after: an ISO 8601 date or time, inclusive
Example:"2026-10-01"
tostringCreated on or before: an ISO 8601 date or time, inclusive
Example:"2026-10-01"
Response
data: List of Voucher, with nextCursor
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"
/vouchers1curl "https://ogawifi.online/api/v1/vouchers?limit=25" \2 -H "Authorization: Bearer $OGAWIFI_API_KEY"1{2 "data": [3 {4 "id": "vch_Zx81kQ0pLm",5 "status": "active",6 "username": "ada-4821",7 "source": "purchase",8 "customerUid": "u_9fK2mP7qR1",9 "customerEmail": "ada@example.com",10 "planId": "pln_8Hq2LmZ0aB3c",11 "planName": "Daily 5GB",12 "locationId": "loc_3cD4eF5gH6",13 "duration": "1 day",14 "dataLimit": "5GB",15 "renewalOf": null,16 "paymentReference": "hs_1761818400000_0123456789abcdef",17 "createdAt": "2026-10-30T10:00:00.000Z",18 "expiresAt": "2026-10-31T10:05:00.000Z"19 }20 ],21 "nextCursor": "1761818400000_vch_Zx81kQ0pLm"22}