Get a List of all downstream Resellers Subscriptions
The Get a List of the Child Reseller's Subscriptions method returns the list of Subscriptions of all downstream Resellers of the current Reseller or any of its downstream Resellers.
Access to the current Reseller and downstream Resellers is determined by the Manager's token in the API request.
GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_subscriptionsArguments
Name | Parameter Type | Data type | Required/ Optional | Description |
|---|---|---|---|---|
| X-Api-Token | header | string | Required | API token of the Manager that performs the operation (see Viewing and updating manager's information) |
| Content-Type | header | string | Required | Indicates the media type (text/html or text/JSON) of the request that is sent to the server by the client (browser) |
| Accept | header | string | Required | Information about data types that the client (browser) supports |
| reseller_id | path | integer | Required | ID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information) |
| page[size] | query | integer | Optional | Page navigation: number of elements per page. The default value is 50 |
| page[number] | query | integer | Optional | Page navigation: page number |
| meta | query | bool | Optional | Request of the additional attributes of the Subscription. Applies to Subscriptions based on the Vendor Service and Office 365 plugins |
Response model
The response model is similar to Get a List of the Reseller's Subscriptions without the included parameter.
Request example
GET /api/v3/resellers/1/child_reseller_subscriptions?meta=true&page[number]=396&page[size]=2
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonResponse example
{
"data": [
{
"id": "3007095",
"type": "subscriptions",
"attributes": {
"created_at": "2020-08-05T05:44:55.355+03:00",
"updated_at": "2020-08-05T06:26:53.948+03:00",
"plan_id": 1200,
"account_id": 523,
"name": "1200 G Suite Business test.activeplatform.com",
"trial": false,
"status": "active",
"start_date": "2020-08-05",
"expiration_date": "2020-09-05",
"plan_period_id": 2014,
"promo_code": null,
"payment_model": "prepay",
"payment_model_parameters": {},
"renewal_settings": {
"autorenew": false,
"disable_autorenew": false,
"autorenew_point": 0,
"manual_renew_point": 0
},
"fixed_price": false,
"ability": {
"stop": true,
"activate": false,
"destroy": true,
"adjust": true,
"switch_plan": true,
"renew": false,
"change_auto_renew_option": true,
"prolong": false,
"change_resources_renewal_order": true,
"decrease_resources_change_order": false
}
},
"relationships": {
"account": {
"data": {
"id": "523",
"type": "accounts"
}
},
"subscription_resources": {
"data": [
{
"id": "34847",
"type": "subscription_resources"
}
]
},
"subscription_period": {
"data": {
"id": "6200",
"type": "subscription_periods"
}
},
"plan": {
"data": {
"id": "1200",
"type": "plans"
}
}
},
"meta": {
"applications": [
{
"user_manual": "<h3>G Suite activation steps</h3><br><ul><li>1. Go to the account admin console <a class=\"link\" href=\"https://admin.google.com\" target=\"blank\">https://admin.google.com</a> using the credentials below.<li><li>2. Accept the G Suite Agreement.<li><li>3. Create a new, strong password for your G Suite Account.<li><li>4. Accept the Term of Service.<li><li>5. Verify your domain to activate G Suite using the \"Start Setup\" button.</li></ul>",
"customer_id": "new1",
"admin_login": "admin",
"domain_name": "test.activeplatform.com",
"first_password": "pass123",
"plugin_name": "Vendor service"
}
]
}
},
{
"id": "3007096",
"type": "subscriptions",
"attributes": {
"created_at": "2020-08-11T08:15:18.760+03:00",
"updated_at": "2020-08-11T08:15:58.394+03:00",
"plan_id": 804,
"account_id": 685,
"name": "CSP monthly",
"trial": false,
"status": "active",
"start_date": "2020-08-11",
"expiration_date": "2022-08-11",
"plan_period_id": 1614,
"promo_code": null,
"payment_model": "prepay",
"payment_model_parameters": {},
"renewal_settings": {
"autorenew": false,
"disable_autorenew": false,
"autorenew_point": 0,
"manual_renew_point": -1
},
"fixed_price": false,
"ability": {
"stop": true,
"activate": false,
"destroy": true,
"adjust": true,
"switch_plan": false,
"renew": true,
"change_auto_renew_option": true,
"prolong": true,
"change_resources_renewal_order": true,
"decrease_resources_change_order": true
}
},
"relationships": {
"account": {
"data": {
"id": "685",
"type": "accounts"
}
},
"subscription_resources": {
"data": [
{
"id": "34848",
"type": "subscription_resources"
}
]
},
"subscription_period": {
"data": {
"id": "6201",
"type": "subscription_periods"
}
},
"plan": {
"data": {
"id": "804",
"type": "plans"
}
}
},
"meta": {
"applications": []
}
}
],
"links": {
"self": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=396&page%5Bsize%5D=2",
"first": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=1&page%5Bsize%5D=2",
"prev": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=395&page%5Bsize%5D=2",
"next": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=397&page%5Bsize%5D=2",
"last": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=573&page%5Bsize%5D=2"
}
}