Billing
Plan, invoices and checkout.
Every endpoint needs Authorization: Bearer lk_live_.... See
Conventions for headers, status codes
and error shape.
Get billing status
GET /v1/billing · scope tenant:read
Response 200
Current billing status.
| Field | Type | Notes |
|---|---|---|
plan |
string | Required. |
display_name |
string | Required. |
mode |
string (api, business, both) |
Required. |
rate_cap_per_min |
integer | Required. |
monthly_included_sends |
integer | Required. |
msgs_this_period |
integer | Required. |
status |
string (active, suspended) |
Required. |
price_naira_per_seat |
integer | Required. |
subscribed_at |
string | |
current_period_end |
string | |
created_at |
string | Required. |
send_units_balance |
integer | Required. |
send_units_next_expiry |
string | |
unit_bundles |
array of UnitBundle | Required. |
catalog |
array of PlanCatalogEntry | Required. |
Errors: 401, 403
Create a plan checkout session
POST /v1/billing/checkout · scope tenant:admin
Request body
| Field | Type | Notes |
|---|---|---|
plan |
string (free, founder, starter, pro, scale) |
Required. |
Response 200
Checkout URL for payment.
| Field | Type | Notes |
|---|---|---|
authorization_url |
string | Required. |
reference |
string | Required. |
Errors: 400, 401, 403, 503
Create a send-units checkout session
POST /v1/billing/units/checkout · scope tenant:admin
Request body
| Field | Type | Notes |
|---|---|---|
bundle |
string (1k, 10k, 50k, 100k, 1pkt, 5pkt, 10pkt, 20pkt) |
Required. |
Response 200
Checkout URL for the selected unit bundle.
| Field | Type | Notes |
|---|---|---|
authorization_url |
string | Required. |
reference |
string | Required. |
units |
integer | Required. |
Errors: 400, 401, 403, 503