Get a single billing group

/billing/groups/{billing_group}

This call retrieves a single billing group, specified by {billing_group}. To find the billing_group, use the call GET billing/groups to list all your billing groups.

The information returned includes the billing group owner, the total balance, and the status of the billing group (pending or confirmed).

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups/{billing_group}

Request

Example request

HTTP

GET /v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7 HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

cURL

curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7"

Header Fields

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

Path Parameters

Name	Description
billing_group required	ID of the billing group you are querying.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.

Response

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

Example response body

JSON

{
{
  "id": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
  "owner": "RFranklin",
  "name": "My billing group",
  "type": "free",
  "pending": false,
  "disabled": false,
  "balance": {
    "currency": "USD",
    "amount": 0
  }
}