Get Capacity Pool
GET https://{{host}}/v3/capacity_pools/:id
Returns a single Capacity Pool.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
countries - Country Object
shared_capacity_groups - Shared Capacity Group Object
qty_based_pricings - Quantity Based Price Object *** |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":{"id":"b8db1d7c-f415-4530-a340-c774bcc1c55f","type":"capacity_pools","attributes":{"name":"Extended","renew_date":"2018-07-21","total_channels_count":10,"assigned_channels_count":6,"minimum_limit":5,"minimum_qty_per_order":1,"setup_price":"25.0","monthly_price":"25.0","metered_rate":"0.02"},"relationships":{"countries":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"}},"shared_capacity_groups":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"},"data":[{"type":"shared_capacity_groups","id":"dd2e8844-6a79-4673-ba1c-c8a4913884cc"}]},"qty_based_pricings":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"}}}},"included":[{"id":"dd2e8844-6a79-4673-ba1c-c8a4913884cc","type":"shared_capacity_groups","attributes":{"name":"Sample group","shared_channels_count":0,"created_at":"2018-06-19T11:41:21.644Z","metered_channels_count":30},"relationships":{"capacity_pool":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool","related":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"}},"dids":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids","related":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"}}}}],"meta":{"api_version":"2022-05-10"}}