Resources

Payment

A customer's payment for a plan

Fields

referencestring

The payment reference

Example:"hs_1761818400000_0123456789abcdef"

statusone of pending, success, failed

Example:"success"

amountKobointeger

What the customer paid, in kobo

Example:50750

tenantShareKobointegernullable

The business's share, in kobo; null when the payment provider reported no split

Example:45000

customerUidstring

Example:"u_9fK2mP7qR1"

customerEmailstring

Example:"ada@example.com"

planIdstring

Example:"pln_8Hq2LmZ0aB3c"

planNamestring

Example:"Daily 5GB"

locationIdstring

Example:"loc_3cD4eF5gH6"

voucherIdstringnullable

Example:"vch_Zx81kQ0pLm"

createdAtstringnullable

ISO 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?