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
Organization ID
Month in format YYYY-MM
Responses
- 200
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
DRAFT- Invoice can be modified as the billing period progressesFINALIZED- Invoice is locked and can't be modified
data
object
Organization ID
Name of the plan
charges
object[]
required
List of charges in the invoice
Unique identifier for the charge
User friendly name of the charge
Number of units consumed
Consumption unit
Total cost for the charge
tiers
object[]
required
Number of units consumed
Starting point when this tier is applicable
Rate per unit
Total cost for the tier
Actual number of units charged for
Amount before any credits/discounts/minimum commitments
Total payable amount
RFC3339 timestamp when this invoice was generated
RFC3339 timestamp when this invoice was last modified
RFC3339 starting time for usage period during which items were added to this invoice
RFC3339 ending time for usage period during which items were added to this invoice
Possible values: [DRAFT, FINALIZED]
{
"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"
}
}
Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}