Skip to main content

BuyElectricityRequest

Exactly one of planId or productId must be present; a body with neither is refused with 400 request.plan_id_required.

planIdstring<uuid>

The plan to buy: the planId the electricity products listing (and GET /v1/plans) returns. Send this or productId; one of them is required.

clientReferencestringrequired
Example: power-4001
productIdstring<uuid>

Alias of planId, kept for existing integrations. Either the plan id or the canonical product id from the listing is accepted.

meterNumberstringrequired
Example: 04123456789
amountKobointeger<int64>required

Amount to vend, in kobo (electricity is variable). Minimum ₦100 (10000 kobo). Our markup is added to compute the charge.

Example: 500000
meterTypestring

Optional meter class; defaults to prepaid. Pass postpaid to pay a postpaid (account-billed) meter. Postpaid coverage is disco-dependent; a postpaid request routed to a provider that cannot vend postpaid is rejected before any charge.

Possible values: [prepaid, postpaid]

Example: prepaid
BuyElectricityRequest
{
  "planId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientReference": "power-4001",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "meterNumber": "04123456789",
  "amountKobo": 500000,
  "meterType": "prepaid"
}