GetInvoiceResponse

data object

org_id string required
Organization ID

plan_name string required
Name of the plan

charges object[] required
List of charges in the invoice

Array [
id string required
Unique identifier for the charge
name string required
User friendly name of the charge
quantity double required
Number of units consumed
unit string required
Consumption unit
total double required
Total cost for the charge
tiers object[] required
Array [
name string required
quantity double required
Number of units consumed
starting_after double required
Starting point when this tier is applicable
price double required
Rate per unit
subtotal double required
Total cost for the tier
]
charged_quantity double required
Actual number of units charged for
]

subtotal double required
Amount before any credits/discounts/minimum commitments

total double required
Total payable amount

created_at date-time required
RFC3339 timestamp when this invoice was generated
Example: 2021-09-01T12:00:00Z

last_modified date-time required
RFC3339 timestamp when this invoice was last modified
Example: 2021-09-01T12:00:00Z

starting_on date-time required
RFC3339 starting time for usage period during which items were added to this invoice
Example: 2021-09-01T12:00:00Z

ending_before date-time required
RFC3339 ending time for usage period during which items were added to this invoice
Example: 2021-09-01T12:00:00Z

status string required

• 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]

memo string
Human-readable description explaining the billing context for this invoice

minimum_commit double
Volume commitment amount applied to the invoice

credits double
Credits applied to the invoice

GetInvoiceResponse

{
  "data": {
    "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
  }
}