This method returns the the services that can be added on an existing subscription. Multiple services are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (mandatory) | Subscription Identifier | The identifier of the the subscription on which the services will be added on. The subscription services are filtered against the subscription services restrictions specified in the active subscription definition, considering the subscriptions that are already owned by the accounts receivable related with the specified subscription. The allowed subscription identifier fields are the following:
| ||||||||||||
provisioning_distributor_identifier (optional) | Provisioning Distributor Identifier | The identifier of the the provisioning distributor that will be used to distribute the services. If specified then the services will be filtered based on the specified provisioning distributor. The allowed provisioning distributor identifier fields are the following:
| ||||||||||||
mandatory (optional) | Boolean | If set to true then only mandatory services will be retrieved. If set to false then only optional services will be retrieved. If not specified at all then all services will be retrieved | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved subscription type service |
| mandatory | String | Determines if the subscription service is mandatory or not. The supported values is MANDATORY or OPTIONAL |
Product Object | The actual product provided by the subscription type service | |
| trial_period | Trial Period Object | Includes the trial period that the service will get on its first activation on the subscription (if any is defined according to the subscription type) Available from CRM.COM R14.17.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": null,
"description": null,
"code": "OK"
},
"data": [
{
"mandatory": "Mandatory",
"id": "DF66A3BBEF58B52A446689574303E237",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "B1E02AFD27BD8D28762873E9EF4880DE",
"description": null,
"code": "P2",
"alternative_code": "P2"
}
},
{
"mandatory": "Mandatory",
"id": "1DC44FAF2BC5E80DB8E3D22DA73C0509",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "ABE5D9A65338174B49463F79A636372A",
"description": null,
"code": "P3",
"alternative_code": "P3"
}
},
{
"mandatory": "Mandatory",
"id": "9E174A86D6BDD6113806DDED598E94BD",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "2A614B4A8F490B9D4D3DF07F786E6E30",
"description": null,
"code": "P4",
"alternative_code": "P4"
}
},
{
"mandatory": "Mandatory",
"id": "99B91098E952335301B5CD3D88F0A6B7",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "D06B37379E0CB614224B3D10BF5450F6",
"description": null,
"code": "P5",
"alternative_code": "P5"
}
},
{
"mandatory": "Mandatory",
"id": "7C8FDC83A91BD6E616D462E477410E5E",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "5C2DCFDD743632AC57AE8147B6EE665E",
"description": null,
"code": "P1",
"alternative_code": "P1"
}
},
{
"mandatory": "Mandatory",
"id": "67C251FCA2514063B9EC5142B7796551",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
"description": "Gold Premium Package",
"code": "Gold",
"alternative_code": "GPP"
}
},
{
"mandatory": "Mandatory",
"id": "E6EE7B0B67B64265BF126BC8274B420B",
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Subscription Packages",
"id": "BC954969D3172372D498D3BB2BA590A0",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "2C0E72A735F71582FFC765F3421CE6A5",
"description": "Platinum Packages",
"code": "Platinum",
"alternative_code": "PS"
}
}
]
}