Skip to main content
POST
Create an email credit purchase invoice

Authorizations

X-API-Key
string
header
default:YOUR_API_KEY
required

Dashboard API key created at https://app.wazobiamail.com/dashboard/smtp-api. Send operations also accept a narrower sending key created through POST /sending/api-keys; every other operation needs the dashboard key.

Body

application/json
currency
enum<string>
required

Currency the invoice is raised in.

Available options:
NGN,
USD
Example:

"USD"

packId
string

A pack id from GET /units/packs. Omit when sending units.

Example:

"pack_credits_1000"

units
integer

Custom credit quantity. Omit when sending packId.

Example:

5000

planId
string

Plan to include when the account has no active paid subscription.

Example:

"starter"

billingInterval
enum<string>
default:monthly

Billing term for an included plan. The server calculates its price and renewal date.

Available options:
monthly,
halfYearly,
yearly,
2years,
4years

Response

Invoice created and awaiting payment.

success
boolean
required
Example:

true

message
string
required
Example:

"Done"

data
any
required

Payload; shape depends on the endpoint.