Invoices
API endpoint for retrieving current and past invoices
Last updated
Was this helpful?
API endpoint for retrieving current and past invoices
Last updated
Was this helpful?
The WarpStream API enables users to retrieve current and past invoices. The responses from this API can be used to monitor costs, and also analyze historical billing data.
The endpoint retrieves the current billing period invoice, providing visibility into charges accrued so far in the billing cycle.
The endpoint retrieves a single invoice from a previous billing period. The date passed in "date_start" does not need to be an exact match for the beginning of the billing cycle. If the date falls within a billing cycle for which an invoice exists, the API will return a response containing the invoice for the full billing period. For example, if the billing period is from April 1 through April 30, passing "date_start": "2025-04-15" will return the invoice for the period starting April 1.
Both endpoints group by Tenant ID, then Workspace ID, then Virtual Cluster ID, providing the ability to analyze line-item-level detail, or rollups aggregated by entity. Finally, account-level charges (such as support billing) and credit consumption are displayed at the top level of the schema.