Invoice

org_idstringrequired

Organization ID

plan_namestringrequired

Name of the plan

charges object[]required

List of charges in the invoice

Array [

idstringrequired

Unique identifier for the charge

namestringrequired

User friendly name of the charge

quantitynumber<double>required

Number of units consumed

unitstringrequired

Consumption unit

totalnumber<double>required

Total cost for the charge

tiers object[]required

Array [

namestringrequired

quantitynumber<double>required

Number of units consumed

starting_afternumber<double>required

Starting point when this tier is applicable

pricenumber<double>required

Rate per unit

subtotalnumber<double>required

Total cost for the tier

]

charged_quantitynumber<double>required

Actual number of units charged for

]

subtotalnumber<double>required

Amount before any credits/discounts/minimum commitments

totalnumber<double>required

Total payable amount

created_atstring<date-time>required

RFC3339 timestamp when this invoice was generated

Example: 2021-09-01T12:00:00Z

last_modifiedstring<date-time>required

RFC3339 timestamp when this invoice was last modified

Example: 2021-09-01T12:00:00Z

starting_onstring<date-time>required

RFC3339 starting time for usage period during which items were added to this invoice

Example: 2021-09-01T12:00:00Z

ending_beforestring<date-time>required

RFC3339 ending time for usage period during which items were added to this invoice

Example: 2021-09-01T12:00:00Z

statusstringrequired

• DRAFT - Invoice can be modified as the billing period progresses
• FINALIZED - Invoice is locked and can't be modified
• PAID - Payment has been collected
• PAST_DUE - Payment is overdue

Possible values: [DRAFT, FINALIZED, PAID, PAST_DUE]

memostring

Human-readable description explaining the billing context for this invoice

minimum_commitnumber<double>

Volume commitment amount applied to the invoice

creditsnumber<double>

Credits applied to the invoice

Invoice

{
  "org_id": "string",
  "plan_name": "string",
  "charges": [
    {
      "id": "string",
      "name": "string",
      "quantity": 0,
      "unit": "string",
      "total": 0,
      "tiers": [
        {
          "name": "string",
          "quantity": 0,
          "starting_after": 0,
          "price": 0,
          "subtotal": 0
        }
      ],
      "charged_quantity": 0
    }
  ],
  "subtotal": 0,
  "total": 0,
  "created_at": "2021-09-01T12:00:00Z",
  "last_modified": "2021-09-01T12:00:00Z",
  "starting_on": "2021-09-01T12:00:00Z",
  "ending_before": "2021-09-01T12:00:00Z",
  "status": "DRAFT",
  "memo": "string",
  "minimum_commit": 0,
  "credits": 0
}