Get a List of Resources by a Subscription ID
The Get a List of Resources by a Subscription ID method returns the list of subscription's resources by given subscription ID.
GET /api/vendor/v1/subscriptions/{id}/resources.json?api_token={api_token}
Arguments
Name | Parameter Type | Data type | Required/ Optional | Description |
---|---|---|---|---|
id | path | integer | Required | A subscription ID. |
api_token | query | string | Required | API token of the manager who perform the operation (see API Token Authentication). |
Response model
Name | Data type | Description |
---|---|---|
id | integer | A subscription ID. |
additional | integer | A number of additional resources. |
used | integer | A number of used resources. |
application_id | integer | Application ID, to which the resources are related. |
plan_resource_id | integer | An ID of the additional resource. |
name | string | A name of the additional resource. |
recurring_fee | integer | A value of monthly fee for the resource. This type of fee is used if the customer has to pay for the resource each month to renew the subscription. |
renewal_fee | integer | A value of fee, which the subscriber has to pay to renew the resource. |
setup_fee | integer | A price of the resource installation. |
limit | integer | The maximum amount of the resource which is available for ordering. If resource is unlimited (unlimited_units=true), then limit equals zero. |
included | integer | A value of the resource which will be included in the plan by default (the included resources are available for free). |
minimum | integer | The minimum available amount of resources (including the value that was set in the "included" parameter). |
unlimited_units | bool | If customers can buy unlimited value of the resource:
|
overuse_fee | integer | A price of the resource if a customer overused the included value of the resource. |
Request example
GET http://billing.activeplatform.com:80/api/vendor/v1/subscriptions/2005882/resources.json?api_token=654321
Response example
[
{
"id": 132524,
"additional": 0,
"used": 0,
"application_id": 2005627,
"plan_resource_id": 2003627,
"name": "MEMORY",
"recurring_fee": "0.0",
"renewal_fee": "0.0",
"setup_fee": "0.0",
"limit": 4096,
"included": 4096,
"minimum": 4096,
"unlimited_units": false,
"overuse_fee": "0.0"
}
]