List invoices

/billing/invoices

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call returns a list of invoices, with information about each, including whether or not the invoice is pending and the billing period it covers.

The call returns information about all your available invoices, unless you use the query parameter bg_id to specify the ID of a particular billing group, in which case it will return the invoice incurred by that billing group only.

https://cavatica-api.sbgenomics.com/v2/billing/invoices

Request

Example request

GET v2/billing/invoices HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET https://cavatica-api.sbgenomics.com/v2/billing/invoices -H "Accept: application/json"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response.

Example response body

{
    "href": "https://cavatica-api.sbgenomics.com/v2/billing/invoices/",
    "items": [
        {
            "href": "https://cavatica-api.sbgenomics.com/v2/billing/invoices/7123459019",
            "invoice_id": "7123459019",
            "pending": false,
            "invoice_period": {
                "from": "2015-03-26T13:55:26Z",
                "to": "2015-03-27T00:00:00Z"
            }
        },
        {
            "href": "https://cavatica-api.sbgenomics.com/v2/billing/invoices/7123458961",
            "invoice_id": "7123458961",
            "pending": false,
            "invoice_period": {
                "from": "2015-03-27T00:00:00Z",
                "to": "2015-03-30T00:00:00Z"
            }
        }
    ]
}

Language
Click Try It! to start a request and see the response here!