Get the downstream Reseller's Subscription information by ID
The Get the Child Reseller's Subscription by ID method returns Subscription details by the given Subscription ID of the downstream Reseller of the current Reseller.
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_subscriptions/{subscription_id}
Arguments
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 downstream Reseller (see Viewing and updating reseller general information) |
subscription_id | path | integer | Required | ID of the Subscription |
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
Name | Data type | Description | |||
---|---|---|---|---|---|
data | object | Response data | |||
id | integer | ID of the Subscription | |||
type | string | Data type | |||
attributes | object | Information about the Subscription | |||
created_at | date | Date and time of the Subscription creation | |||
updated_at | date | Date and time when the Subscription was updated | |||
plan_id | integer | Plan ID of the Subscription (see Managing plans in the ActivePlatform. Operator Control Panel) | |||
account_id | integer | Account ID to which the Subscription is related | |||
name | string | Subscription name | |||
trial | bool | Subscription type:
| |||
status | string | Subscription status (see Viewing the list of Subscriptions) | |||
start_date | date | Activation date of the Subscription | |||
expiration_date | date | Expiration date of the Subscription | |||
plan_period_id | integer | ID of the Plan Period | |||
promo_code | string | Promo code which was used to get the discount | |||
payment_model | string | Subscription payment model:
| |||
payment_model_parameters | object | Payment model parameters | |||
credit_limit | float | The value of the Subscription debt, above which the postpaid Subscription will be stopped. For postpaid Subscription only (payment_model = postpay) | |||
current_debt | float | The Subscription debt that is calculated as the total amount of all blocked Charges for the Subscription for the current Billing period. For postpaid Subscription only (payment_model = postpay) | |||
meta | object | Additional attributes of the Subscription | |||
applications | array | List of the additional attributes of the Subscription. The content depends on the Subscription | |||
'attribute.name' | string | Value of the attribute |
Request example
GET /api/v3/resellers/1/child_reseller_subscriptions/3005076?meta=true
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Response example
{
"data": {
"id": "3005076",
"type": "subscriptions",
"attributes": {
"created_at": "2019-04-02T11:31:07.062+03:00",
"updated_at": "2019-08-22T11:38:04.251+03:00",
"plan_id": 1392,
"account_id": 452,
"name": "Microsoft Azure",
"trial": false,
"status": "active",
"start_date": "2019-02-21",
"expiration_date": "2119-08-23",
"plan_period_id": 2478,
"promo_code": "",
"payment_model": "postpay",
"payment_model_parameters": {
"credit_limit": 1000.0,
"current_debt": 24.0
}
},
"meta": {
"applications": [
{
"plugin_name": "Office365 Plugin",
"tenant_id": "12c459a9-test-test-test-ba5ea90a2018",
"tenant_name": "example.onmicrosoft.com",
"order_id": "1063EA8D-test-test-test-4C5C6BCD515D",
"external_id": "1025E799-test-test-test-15C07F27EFDB"
}
]
}
}
}