{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Get breakdown for a billing group","type":"endpoint","slug":"get-breakdown-for-a-billing-group","excerpt":"/billing/groups/{billing_group}/breakdown\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call returns a breakdown of spending per-project for the billing group specified by `billing_group`. For each project that the billing group is associated with, information is shown on each task run, including its initiating user (the `runner_username`), start and end times, and cost.\n\nTo find the `billing_group`, use the [call to list all your billing groups](doc:list-billing-groups).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/billing/groups/{billing_group}/breakdown\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Billing periods\",\n  \"body\": \"The spending will be shown for the current billing period, unless the billing group specified is a free billing group (i.e. pilot funds that you are using Cavatica with), in which case all spending on the account will be shown.\"\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/billing/groups/8ccc6222-ef6f-4526-99d7-9f56b716d43a/breakdown HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 8ccc6222-ef6f-4526-99d7-9f56b716d43a\\\" -H \\\"content-type: application/json\\\" - X GET \\\"https://cavatica-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`billing_group`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the billing group.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown\\\",\\n  \\\"project_breakdown\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my_project\\\",\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.23\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/39bc3e8c-6cf6-4f8f-b550-21e9633c1f4b\\\",\\n          \\\"runner_username\\\": \\\"Kate\\\",\\n          \\\"time_started\\\": \\\"2015-12-11T11:03:08Z\\\",\\n          \\\"time_finished\\\": \\\"2015-12-11T11:08:49Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        }\\n      ]\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/test\\\",\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.92\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/f586a3fb-c9e4-4415-b22b-648a66969a37\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-26T14:15:18Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-26T14:20:30Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/98c8dc8b-e1e0-4410-8448-d857a9c2cf16\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T16:26:23Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T16:30:46Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/6961273b-0f6a-45a3-95c1-d5d895fc6ea0\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-26T12:11:58Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-26T12:16:33Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n      ]\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/projects/Kate/my-project\\\",\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.46\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/a466e8b9-6f48-4cf9-b903-50fc4701bb2e\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:02:13Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:07:06Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-24T19:19:52Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-24T19:24:45Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n      ]\\n    },\\n    {\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.69\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/468dca93-7e90-4625-bcef-a080151d0687\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:30:45Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:35:31Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/dc0e6559-a706-4e30-a040-72e5bfb3c077\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:37:59Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:47:10Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/a8364b07-f1f9-4548-864a-045a3a2c41a1\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:43:02Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:48:18Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"total_spending\\\": {\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"amount\\\": \\\"2.00\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","updates":[],"order":15,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5773ecb86262f90e00314540","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":18,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"user":"575e85ac41c8ba0e00259a44","parentDoc":null,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"__v":5,"createdAt":"2016-06-29T15:43:52.729Z","githubsync":"","project":"5773dcfc255e820e00e1cd4d"}