Resources
Payment
A customer's payment for a plan
Fields
referencestringThe payment reference
Example:"hs_1761818400000_0123456789abcdef"
statusone of pending, success, failedExample:"success"
amountKobointegerWhat the customer paid, in kobo
Example:50750
tenantShareKobointegernullableThe business's share, in kobo; null when the payment provider reported no split
Example:45000
customerUidstringExample:"u_9fK2mP7qR1"
customerEmailstringExample:"ada@example.com"
planIdstringExample:"pln_8Hq2LmZ0aB3c"
planNamestringExample:"Daily 5GB"
locationIdstringExample:"loc_3cD4eF5gH6"
voucherIdstringnullableExample:"vch_Zx81kQ0pLm"
createdAtstringnullableISO 8601 time, UTC
Example:"2026-10-30T10:00:00.000Z"
Payment
1{2 "reference": "hs_1761818400000_0123456789abcdef",3 "status": "success",4 "amountKobo": 50750,5 "tenantShareKobo": 45000,6 "customerUid": "u_9fK2mP7qR1",7 "customerEmail": "ada@example.com",8 "planId": "pln_8Hq2LmZ0aB3c",9 "planName": "Daily 5GB",10 "locationId": "loc_3cD4eF5gH6",11 "voucherId": "vch_Zx81kQ0pLm",12 "createdAt": "2026-10-30T10:00:00.000Z"13}Was this helpful?