On this page
No Headings
objectusage_periodsrequiredarrayitemsobjectfrom_datetimerequiredobjectdate-timeDate and time in ISO 8601 format.
Starting date of billing period, in the ISO 8601 datetime format in Universal Time (UTC).
to_datetimerequiredobjectdate-timeDate and time in ISO 8601 format.
Ending date of the billing period, in the ISO 8601 datetime format in Universal Time (UTC).
issuing_daterequiredobjectdate^(?:[1-9]\d{3}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))|(?:(?:\d{2}(?:0[48]|[2468][048]|[13579][26]))|(?:[02468][048]00|[13579][26]00))-02-29)$The date of creation of the invoice.
invoice_idstringUnique invoice Id.
total_amountrequiredobjectThe total amount for the current usage period, including all charges and taxes.
taxes_amountrequiredobjectThe total amount of taxes applied to the current usage period.
charges_usagerequiredarrayArray of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage.
itemsobjectunitsrequiredstring^[0-9]+.?[0-9]*$The number of units utilized for a specific charge item.
events_countrequiredintegerThe total count of usage events that have been recorded for a particular charge during the specified time period.
amountrequiredobjectchargerequiredobjectidrequiredstringUnique identifier of the charge
metric_idrequiredstringUnique identifier of the metric
charge_modelstring"STANDARD", "GRADUATED", "PACKAGE", "PERCENTAGE", "VOLUME""STANDARD"Defines the pricing model to calculate the charge
propertiesobjectPricing thresholds that determine the charges
taxesarrayList of tax entities configured for the usage based charge.
itemsobjectRepresents a customizable tax rate that can be applied to invoices and fees
namerequiredstringName of the tax
ratestring^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.
descriptionstringDetailed description of the tax for internal reference
codestring^[a-zA-Z0-9_-]*$Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
idstringuuidUnique identifier of the tax
created_atobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
min_amountobjectmetricrequiredobjectRepresents a metric used for customer usage. It includes the name, code, and aggregation type of the metric.
namerequiredstringName of the metric used for this charge.
coderequiredstringUnique code identifying the metric used for this charge.
aggregation_typerequiredstring | null"COUNT", "SUM", "MAX", "COUNT_DISTINCT", "LATEST"Aggregation type for the metric
metarequiredobjecttotal_countintegertotal_pagesintegercurrent_pageinteger