Get Subscription Info by ID

The Get Subscription Info by ID method returns Subscription details by the given Subscription ID.

GET /api/vendor/v1/subscriptions/{id}.json?api_token={api_token}

Arguments

Name	Parameter Type	Data type	Required/ Optional	Description
id	path	integer	Required	Subscription ID
api_token	query	string	Required	API token of the manager who performs the operation (see API Token Authentication)

Response model

Name		Data type	Description
id		integer	Subscription ID
plan_id		integer	Plan ID of the subscription (see Managing plans in the ActivePlatform. Operator Control Panel).
account_id		integer	ID of the Account that owns the Subscription
name		string	Subscription name
trial		bool	Subscription type: true – trial Subscription. false – full non-trial Subscription.
status		string	Subscription status (see Viewing the list of subscriptions for the list of Subscription statuses)
start_date		date	Subscription activation date
expiration_date		date	Subscription expiration date
plan_period_id		integer	Plan period ID (see Managing plans in the ActivePlatform. Operator Control Panel)
promo_code		string	A promo code, which was used to get the discount (see Managing promo codes in the ActivePlatform. Operator Control Panel).
created_at		date	Date and time of Subscription creation
updated_at		date	Date and time of Subscription last update
hold_to		date	The billing process for the Subscription is skipped till the date because all Subscription Charges were closed manually (see Closing subscription charges manually)
payment_model		string	Subscription payment model: prepay postpay
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)

Request example

GET /api/vendor/v1/subscriptions/3005362.json?api_token=vY5fwetestK3gJXZH5uHCw

Response example

{
    "id": 3005362,
    "plan_id": 1437,
    "account_id": 411,
    "name": " ESET NOD32 Mobile Security",
    "trial": false,
    "status": "deleted",
    "start_date": "2019-12-15",
    "expiration_date": "2020-12-15",
    "plan_period_id": 2597,
    "promo_code": null,
    "created_at": "2019-12-15T10:11:56.599+03:00",
    "updated_at": "2019-05-31T11:05:41.402+03:00",
    "hold_to": null,
    "payment_model": "postpay",
    "payment_model_parameters": {
        "credit_limit": 25.0,
        "current_debt": 0.0
    }
}