Get a List of Applications by a Subscription ID

The Get Applications List by Subscription ID method returns a List of Applications by given subscription ID.

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

Arguments

Name

Parameter Type

Data type

Required/ Optional

Description

id

path

integer

Required

A subscription ID.

api_tokenquerystringRequiredAPI token of the manager who perform the operation (see API Token Authentication).

Response model

Name

Data type

Description

id

integer

An ID of the application instance.

subscription_id

integer

A subscription ID, which based on the application instance.

origin_id

integer

An order number of the application instance.

origin_type

string

An internal type of the application instance, which is used as a polymorphic association.

service_status

string

A service status of the application instance:

  • not_provisioned - provisioning of the application instance was not completed;

  • provisioning - an application instance is being provisioned;

  • provisining_failed - an error during the provisioning process;

  • running - an application instance is running;

  • renewing - an application instance is renewing;

  • renewing_failed - an error during the renewing of the application instance;

  • stopped - an application instance was stopped.

application_template_id

integer

An application template ID, on which base the application instance was created.

created_at

date

A date and time of the application instance's creation.

updated_at

date

A date and time, when the application instance was updated last time.

Request example

 GET http://billing.activeplatform.com:80/api/vendor/v1/subscriptions/2005882/applications.json?api_token=654321

Response example

 [
  {
    "id": 2005627,
    "subscription_id": 2005882,
    "origin_id": 70,
    "origin_type": "Plugin::FusionManager::Application",
    "service_status": "running",
    "application_template_id": 333,
    "created_at": "2016-07-31T04:10:28.920+03:00",
    "updated_at": "2016-07-31T04:10:31.303+03:00"
  }
]