Skip to main content
Metronome supports a shared set of Invoice endpoints that allow you to retrieve, regenerate, and manage invoices associated with both Plans and Contracts. While these endpoints are shared between Plans and Contracts, note that some input and response parameters differ slightly depending on the entity you are targeting. For example, Contract invoices may include commit, credit, or usage details, whereas Plan invoices are generally scoped to plan-level billing events.

​
Available Endpoints

EndpointDescription
/customers/{customer_id}/invoices/{invoice_id}Retrieves a specific invoice for a given customer.
/customers/{customer_id}/invoicesLists all invoices for a given customer.
/invoices/regenerateRegenerates a previously issued invoice.
/invoices/voidVoids an existing invoice.

​
Associated Invoice Parameters

When using these endpoints, the associated invoices will include these parameters:
FieldTypeDescription
plan_idstring (UUID)The unique identifier for the plan associated with this invoice.
plan_namestringThe name of the plan associated with the invoice.
plan_custom_fieldsobjectA map of custom fields defined on the associated plan at the time of invoice generation.
invoice_adjustmentsarrayA list of adjustments applied to the invoice, such as credits, discounts, or manual corrections.
Check out the Contracts version of the documentation here →
⌘I