Vouchers

Get a voucher

GET/vouchers/{id}needsvouchers:read

Never includes the password.

Needs the vouchers:read permission.

Path parameters

idstringrequired

The voucher's id

Response

data: Voucher

idstring

Example:"vch_Zx81kQ0pLm"

statusone of active, expired, failed, superseded

Example:"active"

usernamestring

The login name. The password is never available

Example:"ada-4821"

sourceone of purchase, generated

How it was issued: "purchase" for a sale through the platform, "generated" for a code the business printed and sold itself

Example:"purchase"

customerUidstringnullable

Null when source is "generated"

Example:"u_9fK2mP7qR1"

customerEmailstringnullable

Null when source is "generated"

Example:"ada@example.com"

planIdstring

Example:"pln_8Hq2LmZ0aB3c"

planNamestring

Example:"Daily 5GB"

locationIdstring

Example:"loc_3cD4eF5gH6"

durationstring

Example:"1 day"

dataLimitstringnullable

Example:"5GB"

renewalOfstringnullable

The voucher this renewal took over from

Example:null

paymentReferencestringnullable

Null when source is "generated"

Example:"hs_1761818400000_0123456789abcdef"

createdAtstringnullable

ISO 8601 time, UTC. When it was sold, or for a generated code, when it was first used

Example:"2026-10-30T10:00:00.000Z"

expiresAtstringnullable

Null until the customer first logs in

Example:"2026-10-31T10:05:00.000Z"

GET/vouchers/{id}
1curl "https://ogawifi.online/api/v1/vouchers/$VOUCHER_ID" \2  -H "Authorization: Bearer $OGAWIFI_API_KEY"
200Successful response
1{2  "data": {3    "id": "vch_Zx81kQ0pLm",4    "status": "active",5    "username": "ada-4821",6    "source": "purchase",7    "customerUid": "u_9fK2mP7qR1",8    "customerEmail": "ada@example.com",9    "planId": "pln_8Hq2LmZ0aB3c",10    "planName": "Daily 5GB",11    "locationId": "loc_3cD4eF5gH6",12    "duration": "1 day",13    "dataLimit": "5GB",14    "renewalOf": null,15    "paymentReference": "hs_1761818400000_0123456789abcdef",16    "createdAt": "2026-10-30T10:00:00.000Z",17    "expiresAt": "2026-10-31T10:05:00.000Z"18  }19}
Was this helpful?