get https://cavatica-api.sbgenomics.com/v2
/billing/groups/{billing_group}
For general information on the API, including formatting, parameters, and pagination, please see the API Overview.
This call retrieves a single billing group, specified by {billing_group}
. To find the billing_group
, use List billing groups. The information returned includes the billing group owner, the total balance, and the status of the billing group (pending or confirmed).
https://cavatica-api.sbgenomics.com/v2/billing/groups/{billing_group}
Request
Example request
GET /v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7 HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7"
Header Fields
Name | Description |
---|---|
X-SBG-Auth-Token required | Your CAVATICA 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 CAVATICA-specific response codes that may be contained in the body of the response.
Example response body
{
"id": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
"href": "https://cavatica-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
"owner": "RFranklin",
"name": "Pilot Funds (RFranklin)",
"type": "free",
"pending": false,
"disabled": false,
"balance": {
"currency": "USD",
"amount": 0
}
}