billing

What the payment provider says the next invoice will charge

The provider's own invoice preview, line for line, with the period it covers. source is provider when these are the provider's figures, none when no provider subscription holds this org, and unavailable when the provider could not be read — there is no fallback estimate, because a figure that is not the provider's is not what you will be charged. The month-end projection is a different question: usage/summary.

get/v1/orgs/{org_id}/billing/next-invoice

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/orgs/{org_id}/billing/next-invoice
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

org_idstring required

Response

OK

amount_due_microsinteger required

meaningful only when source is provider

currencystring required

ISO 4217

discount_microsinteger required

what the provider's discounts take off, as a positive amount; the lines carry their full figures

has_prorationboolean required
period_endstring date-time
period_startstring date-time

start of the period this invoice covers

sourcestring required

provider | none | unavailable

tax_microsinteger required

tax the provider computed; not a line, so lines + tax is the total

Changes

No recorded changes to this operation across all 1 revision of this API.