List invoices

/billing/invoices

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

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/invoices

Request

Example request

HTTP

GET v2/billing/invoices HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/invoices -H "Accept: application/json"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your Platform authentication token.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.
billing_group	string	ID of the billing group for which you want to list invoices.

Response

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

Example response body

JSON

{
    "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/invoices/",
    "items": [
        {
            "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/invoices/7123079019",
            "invoice_id": "7123079019",
            "pending": false,
            "invoice_period": {
                "from": "2015-03-26T13:55:26Z",
                "to": "2015-03-27T00:00:00Z"
            }
        },
        {
            "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/invoices/7123918961",
            "invoice_id": "7123918961",
            "pending": false,
            "invoice_period": {
                "from": "2015-03-27T00:00:00Z",
                "to": "2015-03-30T00:00:00Z"
            }
        }
    ]
}