Get invoice for a month | Tigris Object Storage Documentation
Get invoice for a month
GET https://mgmt.storage.dev/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 string required
Provider ID
org_id string required
Organization ID
month string required
Month in format YYYY-MM
Responses
- 200
- default
OK
application/json
Schema
Example (auto)
Schema
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 progressesFINALIZED- Invoice is locked and can't be modifiedPAID- Payment has been collectedPAST_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
{
"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
}
}
Unexpected error
application/json
Schema
Example (auto)
Schema
message string
{
"message": "string"
}
Authorization: X-Tigris-Signature
name: X-Tigris-Signature
type: apiKey
in: header
description: HMAC-SHA256 of the canonical request signed using the signing key.
To create the signature, concatenate the HTTP method, URL, timestamp, and nonce with a newline character in between.
Then, calculate the HMAC-SHA256 of the concatenated string using the signing key. Example:
Create the `canonical_request` as:
POST https://mgmt.storage.dev/provider/your-provider-id/orgs/user-org-id/provision 1731703213870 f8d133cb-5a42-47b1-9ef2-874bb55bab72
Then, calculate HMAC-SHA256 of the canonical request using the signing key as:
Signature = hex(sha256sign(canonical_request, "signing_key"))
name: X-Tigris-Nonce type: apiKey in: header description: Random unique string to identify the request and prevent replay attacks. Example: "f8d133cb-5a42-47b1-9ef2-874bb55bab72"
name: X-Tigris-Time type: apiKey in: header description: Unix timestamp in milliseconds of the request. Example: 1731703213870
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- postman-cli
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/invoices/:month");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Tigris-Signature", "<X-Tigris-Signature>");
request.Headers.Add("X-Tigris-Nonce", "<X-Tigris-Nonce>");
request.Headers.Add("X-Tigris-Time", "<X-Tigris-Time>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
RequestCollapse all
Base URL
Edit
Auth
Signature
Nonce
Timestamp
Parameters
provider_id — path required
org_id — path required
month — path required
Send API Request
ResponseClear
Click the Send API Request button above and see the response here!