nextmail.billing
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The plan of the workspace and what it costs, as Billing shows them: the plan and its usage, the plans on sale, pay as you go, every charge with its invoice, and the links that start a checkout or open the billing portal. Only the workspace owner reaches it, and nothing is paid through the API.
nextmail.billing.get()
Read the plan
get(options?: RequestScope): Promise<BillingResource>Resolves the plan of the workspace and what it includes, as Billing shows it: how it is billed, when it renews or ends and the next charge, how many domains it holds, how much of this month's sends and today's AI actions are used, and pay as you go. metered is false while billing is switched off, and then nothing is capped.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingResource with plan, interval, renewsAt, nextCharge, domains, usage and payAsYouGo.
Example
const billing = await nextmail.billing.get() console.log(billing.planName, billing.usage.sends.used, billing.usage.sends.limit)Notes
A limit of
nullmeans the plan has none.
Also available in
- API
GET /billing- Python
billing.get()- Ruby
billing.get- PHP
billing->get- Go
Billing.Get- Java
billing().get- C#
Billing.GetAsync- CLI
nextmail billing get
nextmail.billing.listPlans()
List the plans
listPlans(options?: RequestScope): Promise<BillingPlanListResource>Resolves every plan, cheapest first, with its price in US cents and what it includes. available says whether it is on sale, and intervals the billing intervals it is sold at.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingPlanListResource with one BillingPlanResource per plan in data.
Example
const { data } = await nextmail.billing.listPlans() const sold = data.filter((plan) => plan.available)Also available in
nextmail.billing.getUsage()
Read the usage history
getUsage(options?: BillingUsageOptions): Promise<BillingUsageResource>Resolves the sends and AI actions of each day, and what pay as you go extras cost each month, as the Usage charts show them.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.daysBillingUsageWindowHow many days back to go, from 1 to 3,660, or
allfor every day since the workspace was made. The server defaults to 30.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingUsageResource with days, months, dailyAiActions and monthlySends.
Example
const usage = await nextmail.billing.getUsage({ days: 90 }) const sent = usage.days.reduce((total, day) => total + day.sends, 0)Also available in
nextmail.billing.listAlerts()
List the billing alerts
listAlerts(options?: RequestScope): Promise<BillingAlertListResource>Resolves what the billing banner of the app would say now, most urgent first: a failed payment, paused pay as you go, sending or AI paused at a limit, a plan about to end, an allowance nearly used and a charge coming soon. An empty list means there is nothing to say.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingAlertListResource with one BillingAlertResource per alert in data.
Example
const { data } = await nextmail.billing.listAlerts() const blocked = data.filter((alert) => alert.severity === 'blocked')Notes
An alert keeps its
idwhile the same thing is true, so one that was dismissed can stay dismissed.
Also available in
nextmail.billing.listCountries()
List the billing countries
listCountries(options?: RequestScope): Promise<BillingCountryListResource>Resolves every country a billing address can be in, as the two-letter ISO 3166 codes saveInvoiceDetails takes as country.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingCountryListResource with the codes in data.
Example
const { data } = await nextmail.billing.listCountries() console.log(data.includes('DE'))Also available in
nextmail.billing.getPayAsYouGo()
Read pay as you go
getPayAsYouGo(options?: RequestScope): Promise<PayAsYouGoResource>Resolves pay as you go on the workspace: whether usage past the allowances is billed, the monthly limit and what extras cost so far, the current billing period once it is set up, the limits that can be chosen and the prices.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
PayAsYouGoResource with the state, limits, prices and period.
Example
const payg = await nextmail.billing.getPayAsYouGo() console.log(payg.enabled, payg.spentCents, payg.limitCents)Notes
Amounts are in US cents.
Also available in
nextmail.billing.setPayAsYouGo()
Turn pay as you go on or off
setPayAsYouGo(body: PayAsYouGoSet, options?: RequestScope): Promise<PayAsYouGoSwitchResource>Turns pay as you go on or off, as the switch on Billing does. Off takes effect at once, and usage stops at the allowances. On takes effect at once when a card is already saved. The first time, checkoutUrl is a link where the person adds a card, and pay as you go starts once they have: call confirmPayAsYouGo after they return.
Nothing is paid through the API: the person pays, changes the card or cancels on the billing provider's page the link opens, as they do from the app.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
body.enabledbooleanRequiredtrueto turn it on,falseto turn it off.body.themeBillingThemelightordark, for the page the link opens.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
PayAsYouGoSwitchResource with enabled, suspended, activating and checkoutUrl.
Example
const result = await nextmail.billing.setPayAsYouGo({ enabled: true }) if (result.checkoutUrl) console.log('Add a card here:', result.checkoutUrl)Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.Turning it on while pay as you go is unavailable is 503
billing_not_configured.The SDK does not retry it.
Also available in
nextmail.billing.setPayAsYouGoLimit()
Set the pay as you go limit
setPayAsYouGoLimit(body: PayAsYouGoLimitSet, options?: RequestScope): Promise<PayAsYouGoLimitResource>Sets the monthly spending limit of pay as you go, in US cents, one of the amounts getPayAsYouGo lists in limits. Extras stop for the rest of a calendar month once it is reached.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
body.limitCentsnumberRequiredThe limit in US cents: 1,000, 2,500, 5,000, 10,000, 25,000, 50,000, 100,000, 250,000 or 500,000.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
PayAsYouGoLimitResource with limitCents.
Example
await nextmail.billing.setPayAsYouGoLimit({ limitCents: 10_000 })Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.A workspace where pay as you go was never set up is 409
pay_as_you_go_not_enrolled.The SDK does not retry it.
Also available in
nextmail.billing.confirmPayAsYouGo()
Confirm pay as you go
confirmPayAsYouGo(options?: RequestScope): Promise<PayAsYouGoConfirmationResource>Checks with the billing provider whether the card from a pay as you go checkout was saved, and records it, as the app does when the person comes back from the checkout. enabled says whether pay as you go is on now.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
PayAsYouGoConfirmationResource with enabled.
Example
const { enabled } = await nextmail.billing.confirmPayAsYouGo()Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.It is safe to call again.
The SDK does not retry it.
Also available in
nextmail.billing.startCheckout()
Start a checkout
startCheckout(body: BillingCheckoutCreate, options?: RequestScope): Promise<BillingCheckoutResource>Starts buying a paid plan for a workspace on Free, as choosing a plan in the app does, and resolves with the link to the checkout. Nothing is charged until the person pays there, and the plan starts once they have. A workspace that already pays for a plan changes it with openPortal instead.
Nothing is paid through the API: the person pays, changes the card or cancels on the billing provider's page the link opens, as they do from the app.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
body.planPaidPlanIdRequiredstarter,businessorenterprise.body.intervalBillingIntervalmonthoryear. Defaults tomonth.body.themeBillingThemelightordark, for the page the link opens.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingCheckoutResource with url.
Example
const { url } = await nextmail.billing.startCheckout({ plan: 'business', interval: 'year' }) console.log('Pay here:', url)Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.A workspace that already pays for a plan is 409
plan_conflict, and a plan or interval that is not on sale is 422plan_unavailable.The SDK does not retry it.
Also available in
nextmail.billing.openPortal()
Open the billing portal
openPortal(body?: BillingHandoff, options?: RequestScope): Promise<BillingPortalResource>Resolves with a link to the billing portal, where the person changes or cancels the plan, updates the card and downloads past invoices, as Manage does in the app.
Nothing is paid through the API: the person pays, changes the card or cancels on the billing provider's page the link opens, as they do from the app.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
body.themeBillingThemelightordark, for the page the link opens.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingPortalResource with url.
Example
const { url } = await nextmail.billing.openPortal({ theme: 'dark' })Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.The SDK does not retry it.
Also available in
nextmail.billing.listInvoices()
List the charges
listInvoices(options?: BillingInvoiceListOptions): Promise<BillingInvoiceListResource>Resolves every charge of the workspace with the state of its invoice, a page at a time, as History on Billing lists them. search matches the plan, the invoice number, the charge id and the name billed.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.pagenumberWhich page, from 1.
options.limitnumberCharges per page, from 1 to 100. The server defaults to 25.
options.sortBillingInvoiceSortnewest, the default, oroldest.options.searchstringWords to look for, up to 120 characters.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingInvoiceListResource with data, total, page, limit, hasMore and metered.
Example
const { data } = await nextmail.billing.listInvoices({ limit: 10 }) const unpaid = data.filter((charge) => !charge.paid)Notes
A provider that does not answer is 502
billing_unreachable.
Also available in
nextmail.billing.getInvoice()
Get the invoice of a charge
getInvoice(orderId: string, options?: RequestScope): Promise<BillingInvoiceLinkResource>Resolves with the link to the invoice of one charge, as a PDF, and its file name. An invoice that was not written yet is written first, which can take a few seconds. The link is signed by the billing provider, downloads the PDF and stops working after a while, so fetch it again rather than keeping it.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
orderIdstringRequiredThe charge id, as
listInvoicesreturns it.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingInvoiceLinkResource with url and fileName.
Example
const { data } = await nextmail.billing.listInvoices({ limit: 1 }) const invoice = await nextmail.billing.getInvoice(data[0].id) console.log(invoice.fileName, invoice.url)Notes
A charge with no billing name and address is 409
billing_details_required: save them withsaveInvoiceDetails. A draft or void charge is 409invoice_unavailable, and an invoice still being written is 504invoice_not_ready.
Also available in
nextmail.billing.saveInvoiceDetails()
Save the billing details of a charge
saveInvoiceDetails(orderId: string, body: BillingDetailsSet, options?: RequestScope): Promise<BillingInvoiceDetailsResource>Saves the name and address billed on a charge, as the Billing address dialog does, keeps the address for later charges, and starts writing its invoice. invoice is ready when the charge already had one, started when it is being written, and refused with the reason in message.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
orderIdstringRequiredThe charge id, as
listInvoicesreturns it.body.namestringRequiredWho is billed, up to 200 characters.
body.line1stringRequiredThe street address, up to 200 characters.
body.line2stringA flat, suite or building, up to 200 characters.
body.citystringRequiredUp to 120 characters.
body.postalCodestringUp to 40 characters.
body.statestringThe state or region, up to 60 characters. In the US and Canada, its two-letter code.
body.countrystringRequiredA two-letter ISO 3166 code, one of those
listCountriesreturns.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
BillingInvoiceDetailsResource with invoice and message.
Example
await nextmail.billing.saveInvoiceDetails(chargeId, { name: 'Acme Ltd', line1: '1 Market Street', city: 'London', postalCode: 'EC1A 1AA', country: 'GB'})Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.An address the billing provider refuses is 422
billing_address_rejected.The SDK does not retry it.
Also available in
nextmail.billing.listAddOns()
List add-ons
listAddOns(options?: RequestScope): Promise<AddOnListResource>Resolves what can be bought on top of the plan, today the dedicated sending IP: whether it is for sale, its price per IP a month in priceCents, whether the workspace has it and when it ends, the IPs it brought, and eligibility, which says whether the workspace qualifies. A dedicated IP needs the Business or Enterprise plan and at least 100,000 emails sent in a month, because below that volume it delivers worse than the shared IPs.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
AddOnListResource with one AddOnResource per add-on in data: addOn, available, status, priceCents, endsAt, eligibility and ips.
Example
const { data } = await nextmail.billing.listAddOns() const dedicated = data.find((item) => item.addOn === 'dedicated-ip') console.log(dedicated?.eligibility.eligible, dedicated?.eligibility.reason)Notes
statusis null until the workspace has the add-on.pendingis paid and being set up,warmingandactivesend through the dedicated IP, andreleasingis being taken down.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client
maxRetries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
nextmail.billing.startAddOnCheckout()
Start a checkout for an add-on
startAddOnCheckout(body: AddOnCheckoutCreate, options?: RequestScope): Promise<AddOnCheckoutResource>Starts buying an add-on, as the button under Billing does, and resolves with the link to the checkout. Nothing is charged until the person pays there. Once it is paid the dedicated IP is set up and warmed up, which sending.listDedicatedIps shows.
Nothing is paid through the API: the person pays on the billing provider's page the link opens, as they do from the app.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
body.addOnAddOnIdRequiredThe add-on to buy:
dedicated-ip.body.themeBillingThemelightordark, for the page the link opens.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
AddOnCheckoutResource with addOn and url.
Example
const { url } = await nextmail.billing.startAddOnCheckout({ addOn: 'dedicated-ip' }) console.log('Pay here:', url)Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.A workspace that already has the add-on is 409
add_on_already_active, one that does not qualify is 409add_on_not_eligible, and when every IP is taken it is 409add_on_sold_out. While add-ons are not on sale it is 503add_on_unavailable.The SDK does not retry it.
Also available in
nextmail.billing.cancelAddOn()
Cancel an add-on
cancelAddOn(addOn: AddOnId, options?: RequestScope): Promise<AddOnResource>Cancels an add-on. It stays until the end of the month already paid for, which endsAt gives. Then the dedicated IP is released and mail leaves through the shared IPs again.
Billing belongs to the owner of the workspace: an API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
addOnAddOnIdRequiredThe add-on to cancel:
dedicated-ip.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
AddOnResource, now with endsAt set.
Example
const addOn = await nextmail.billing.cancelAddOn('dedicated-ip') console.log('Ends at', addOn.endsAt)Notes
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.A workspace that does not have the add-on, or whose add-on is already ending, is 409
add_on_not_active.The SDK does not retry a delete.
Google Workspace
Fastmail