List invoices

/billing/invoices

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://cgc-api.sbgenomics.com/v2/billing/invoices

Request

Example request

GET v2/billing/invoices HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET https://cgc-api.sbgenomics.com/v2/billing/invoices -H "Accept: application/json"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CGC authentication token.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

Response

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

Example response body

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