Module billing_api

Source

Structs§

GetInvoiceByIdParams
struct for passing parameters to the method get_invoice_by_id
GetInvoiceMtdParams
struct for passing parameters to the method get_invoice_mtd
GetInvoiceParams
struct for passing parameters to the method get_invoice

Enums§

GetInvoiceByIdError
struct for typed errors of method get_invoice_by_id
GetInvoiceError
struct for typed errors of method get_invoice
GetInvoiceMtdError
struct for typed errors of method get_invoice_mtd

Functions§

get_invoice
Get the invoice for a given year and month. Can be any month from when the Customer was created to the current month.
get_invoice_by_id
Get the invoice for the given invoice_id.
get_invoice_mtd
Get the current month-to-date estimate. This endpoint has two different responses. Under normal circumstances, it generally takes less than 5 seconds to generate but in certain cases can take up to 60 seconds. Once generated the month-to-date estimate is cached for 4 hours, and is available the next request will return the JSON representation of the month-to-date estimate. While a report is being generated in the background, this endpoint will return a 202 Accepted response. The full format of which can be found in detail in our billing calculation guide. There are certain accounts for which we are unable to generate a month-to-date estimate. For example, accounts who have parent-pay are unable to generate an MTD estimate. The parent accounts are able to generate a month-to-date estimate but that estimate will not include the child accounts amounts at this time.