GET subscriptions/configuration/get_package_information
- p_demou (Deactivated)
- Georgia Kountouri
- George Rossides (Unlicensed)
Owned by p_demou (Deactivated)
Available from CRM.COM R14.0.0
Deprecated from CRM.COM R17.0.0
This method returns the information of a subscription type classified as "Package", such as the mandatory and additional termed services, installed items, and billing term scheme attributes
Resource URL
Parameters
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||
type_identifier (mandatory) | Subscription type identifier | The subscription type classified as "Package" for which the items are retrieved for. The allowed subscription type identifier fields are the following:
| ||||||||||||
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 package Available from CRM.COM R15.0.0 |
name | String | The name of the retrieved package Available from CRM.COM R15.0.0 |
alternative_code | String | The alternative code of the retrieved package Available from CRM.COM R15.0.0 |
| description | String | A description of the retrieved package Available from CRM.COM R15.0.0 |
subscriptions_model | String | Defines whether the subscription type is configured to be used for COMMERCIAL or RESIDENTIAL packages Available from CRM.COM R15.0.0 |
| base_rate | Number | The base rate of the whole package calculated in the system's currency, based on the the package's mandatory termed services |
| base_rate_uot | String | The unit of time of the package base rate. The value can be either DAYS, WEEKS, MONTHS or YEARS |
| billing_terms | Billing terms object | The billing terms provided by the subscription type. |
| mandatory_termed_services_set | Set of package mandatory termed service objects | The mandatory termed subscription services that can be provided by the subscription type. |
| additional_termed_services_set | Set of package additional termed service objects | The additional termed subscription services that can be provided by the subscription type. |
| physical_goods_set | Set of package physical good objects | The subscription physical goods that can be provided by the subscription type. |
| expenses_set | Set of product objects | The subscription expenses that can be provided by the subscription type. |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": [
{
"additional_termed_services_set": [
{
"base_rate": 10,
"provisioning_distributor": {
"alternative_code": "VT1",
"name": "VCAN TWIN 1",
"id": "37029F7E67CA4157BB31F7D5FA5C3659"
},
"service": {
"code": "National Geographic",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"udr_type": null,
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "NG",
"description": "National Geographic",
"id": "6F0D91CBBF9E495795539FC0D5784213",
"priority_level": null
}
},
{
"base_rate": 10,
"provisioning_distributor": {
"alternative_code": "VM",
"name": "VCAS MAIN",
"id": "DE268CE0DA5042509D31F94D16372955"
},
"service": {
"code": "Bronze",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"udr_type": null,
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "B",
"description": "Bronze",
"id": "F50CC52934BD4F119B6E18E215A4FC55",
"priority_level": null
}
},
{
"base_rate": 10,
"provisioning_distributor": {
"alternative_code": "VM",
"name": "VCAS MAIN",
"id": "DE268CE0DA5042509D31F94D16372955"
},
"service": {
"code": "Gold",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"udr_type": null,
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "G",
"description": "Gold",
"id": "D1EB074DFD904E54A0C67CAB9DC7E010",
"priority_level": null
}
},
{
"base_rate": 6,
"provisioning_distributor": {
"alternative_code": "VT2",
"name": "VCAS Twin 2",
"id": "F510E5318416431980064278E1867901"
},
"service": {
"code": "Music1",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"udr_type": null,
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "M",
"description": "Music1",
"id": "D6453416BB704BC4A5448C06F361B5D3",
"priority_level": null
}
}
],
"base_rate": 95,
"mandatory_termed_services_set": [
{
"base_rate": 40,
"provisioning_distributor": {
"alternative_code": "VT1",
"name": "VCAN TWIN 1",
"id": "37029F7E67CA4157BB31F7D5FA5C3659"
},
"service": {
"code": "Silver",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"udr_type": null,
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "SLV",
"description": "SILVER",
"id": "AF390B58BCE646D485EAC39D44C2C81C",
"priority_level": null
}
},
{
"base_rate": 25,
"provisioning_distributor": {
"alternative_code": "VM",
"name": "VCAS MAIN",
"id": "DE268CE0DA5042509D31F94D16372955"
},
"service": {
"code": "Movies 1",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"udr_type": null,
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "M1",
"description": "Movies 1",
"id": "571C10876AF840088372A94A14D0A02C",
"priority_level": null
}
},
{
"base_rate": 30,
"provisioning_distributor": {
"alternative_code": "VM",
"name": "VCAS MAIN",
"id": "DE268CE0DA5042509D31F94D16372955"
},
"service": {
"code": "Sports 1",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AS",
"udr_type": null,
"composition_method": "FLAT",
"name": "Additional Services",
"description": null,
"id": "C8321F0BCA8A4051857BC35CEEE41555",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S1",
"description": "Sports 1",
"id": "02191FFC231D4FBD844D0BB66EBAB14B",
"priority_level": null
}
}
],
"physical_goods_set": [
{
"base_rate": 1,
"provisioning_distributor": {
"alternative_code": "VM",
"name": "VCAS MAIN",
"id": "DE268CE0DA5042509D31F94D16372955"
},
"physical_good": {
"code": "Set-top-box",
"product_type": {
"meter_reading_type": null,
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "STB",
"udr_type": null,
"composition_method": "FLAT",
"name": "SET TOP BOX",
"description": "SET TOP BOX",
"id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "STB",
"description": "Set-top-box",
"id": "D613415339C14975B28BB4FC11598E93",
"priority_level": null
}
},
{
"base_rate": 2,
"provisioning_distributor": {
"alternative_code": "VM",
"name": "VCAS MAIN",
"id": "DE268CE0DA5042509D31F94D16372955"
},
"physical_good": {
"code": "Smartcard",
"product_type": {
"meter_reading_type": null,
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "S",
"udr_type": null,
"composition_method": "FLAT",
"name": "SMARTCARD",
"description": "SMARTCARD",
"id": "D6BE0209EC0149989A89972CE889DF8B",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "SC1",
"description": "asd",
"id": "4F656ED5DAC44168B0805227881202CD",
"priority_level": null
}
}
],
"expenses_set": [
{
"base_rate": 5,
"expense": {
"code": "Installation Fee",
"product_type": {
"meter_reading_type": null,
"service_type": "EXPENSE",
"used_for_provisioning": false,
"alternative_code": "006",
"udr_type": null,
"composition_method": "FLAT",
"name": "Fees",
"description": "Fees One Time Services",
"id": "6",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "E1",
"description": "Expense 1",
"id": "A9917A7895044BEF9499DD6958539D33",
"priority_level": null
}
}
],
"billing_terms": {
"billing_frequency": "MONTHLY",
"billing_term_scheme": {
"billing_method": "PERIOD",
"code": "Pania Package",
"name": "Pania Package",
"billing_type": "NORMAL",
"id": "E216618B586943FEBCF4C561F7BAACCD",
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS"
},
"price_plan": {
"code": "Pania Package2",
"name": "Pania Package2",
"effective_date": "2018-01-22T00:00:00",
"description": null,
"id": "62DF32CC328E4AC1989D6064EA7B1AB0",
"type": "BASE",
"expiration_date": null
},
"binding_period": null
},
"base_rate_uot": "MONTHS"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}