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.

An API token of a Manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.

The Manager's API token specified in an API request determines the current Reseller and downstream Resellers accessible within a method.

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 a Manager that performs the operation (see Viewing and updating manager's information)
Content-Type	header	string	Required	Media type of the request. Specify the following: application/vnd.api+json
Accept	header	string	Required	Supported media types of the answer. Specify the following: application/vnd.api+json
base_url	path	string	Required	ActivePlatform URL
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

The response model is similar to Get the Reseller's Subscription information by ID without the included parameter.

Request example

GET /api/v3/resellers/1/child_reseller_subscriptions/3007095?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": "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,
				"decrease_resources_prolong_order": false
            },
            "custom_price": 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"
                }
            ]
        }
    }
}