Get invoice for a month

GET 
/v1/providers/:provider_id/orgs/:org_id/invoices/:month

Returns the invoice for the specified month. The invoice will include all the charges for the month.

Request

Path Parameters

provider_id stringrequired

Provider ID

org_id stringrequired

Organization ID

month stringrequired

Month in format YYYY-MM

Responses

200

OK

application/json

Schema

Schema

data

object

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

quantitydoublerequired

Number of units consumed

unitstringrequired

Consumption unit

totaldoublerequired

Total cost for the charge

tiers

object[]

required

Array [

namestringrequired

quantitydoublerequired

Number of units consumed

starting_afterdoublerequired

Starting point when this tier is applicable

pricedoublerequired

Rate per unit

subtotaldoublerequired

Total cost for the tier

]

charged_quantitydoublerequired

Actual number of units charged for

]

subtotaldoublerequired

Amount before any credits/discounts/minimum commitments

totaldoublerequired

Total payable amount

created_atdate-timerequired

RFC3339 timestamp when this invoice was generated

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

last_modifieddate-timerequired

RFC3339 timestamp when this invoice was last modified

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

starting_ondate-timerequired

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

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

ending_beforedate-timerequired

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

Possible values: [DRAFT, FINALIZED]

Example (from schema)

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

default

Unexpected error

application/json

Schema

Schema

messagestring

Example (from schema)

{
  "message": "string"
}