Versions Compared

Old Version 4

changes.mady.by.user p_demou (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Antonis Papageorgiou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...


Excerpt

GET subscriptions/show

This method returns information related with a subscription. A single subscription is returned by each call

Resource URL

http://host_name/crmapi/rest/$version/subscriptions/show

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Identifier  

The identifier of the subscription that should be returned as a result. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: GET 


Request:

Response:

Code Block
themeConfluence
{
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "billing_terms":
           {
               "binding_information":
               {
                   "state": "IN_BINDING",
                   "end_date": "2016-04-22T00:00:00",
                   "start_date": "2015-04-22T00:00:00",
                   "binding_period":
                   {
                       "name": "Annual",
                       "code": "ANNUAL"
                   }
               },
               "agreement_date": "2015-04-22T00:00:00",
               "concurrent_usage_based_pricing":
               {
               },
               "billing_term_scheme":
               {
                   "life_cycle_state": "EFFECTIVE",
                   "billing_method": "ANNIVERSARY",
                   "classification": "SUBSCRIPTIONS",
                   "id": "1FD23406A7A227F21D45FDB5D33C4942",
                   "name": "Anniversary BT Scheme",
                   "code": "ABTS",
                   "billing_type": "NORMAL"
               },
               "effective_date": "2015-04-22T00:00:00",
               "billing_frequency":
               {
                   "name": "Monthly",
                   "code": "MONTHLY"
               },
               "id": "EC3C907E0564415F9B1DE9C6DC89CC67",
               "allowed_cancel_date": "2016-04-22T12:15:05",
               "billing_cycle_day": 1,
               "price_plan":
               {
                   "effective_date": "2014-08-01T00:00:00",
                   "type": "BASE",
                   "id": "76A0E2FDB06089CAF5211B8A4F1A5F91",
                   "name": "Standard_Edited",
                   "description": "Standard Price PLan for all Normal Subscribers",
                   "code": "SE",
                   "expiration_date": "2015-12-31T00:00:00"
               }
           },
           "number": "S60415",
           "usage_services_distribution_set":
           [
           ],
           "installed_items_distribution_set":
           [
               {
                   "provisioning_distributor":
                   {
                       "id": "B192D909D9B041F89FA8A197DC0F709A",
                       "name": "Main ",
                       "alternative_code": "M"
                   },
                   "subscription_installed_item":
                   {
                       "ownership_status": "RENTED_TO_CUSTOMER",
                       "installed_item":
                       {
                           "state": "EFFECTIVE",
                           "serial_number": "10109090",
                           "id": "CE0442B8BAA84B37A3E1D4A0C3B41995",
                           "alternative_code": "Dec10109090",
                           "product":
                           {
                               "product_type":
                               {
                                   "physical_good_type": "TRACEABLE",
                                   "used_for_provisioning": true,
                                   "classification": "PHYSICALGOODS",
                                   "composition_method": "FLAT",
                                   "id": "B4A1396AE3D1384B304A0FEB22F7BA50",
                                   "name": "Decoders",
                                   "description": "Decoders",
                                   "alternative_code": "D"
                               },
                               "id": "E8672BB71A9B1BD25E30705AC34D7D61",
                               "description": "Decoders 1",
                               "code": "Decoders 1",
                               "alternative_code": "D1"
                           }
                       },
                       "id": "341C8CFF3EB04E11A8EE339CCE380D4D"
                   },
                   "id": "6E69150D8A714781AEAF09E4060A5F84"
               },
               {
                   "provisioning_distributor":
                   {
                       "id": "B192D909D9B041F89FA8A197DC0F709A",
                       "name": "Main ",
                       "alternative_code": "M"
                   },
                   "subscription_installed_item":
                   {
                       "ownership_status": "RENTED_TO_CUSTOMER",
                       "installed_item":
                       {
                           "state": "EFFECTIVE",
                           "serial_number": "sc1000001217",
                           "id": "31EFF030A6C14069B60A4EC035D7A4A8",
                           "alternative_code": "sc1000001217",
                           "product":
                           {
                               "product_type":
                               {
                                   "physical_good_type": "TRACEABLE",
                                   "used_for_provisioning": true,
                                   "classification": "PHYSICALGOODS",
                                   "composition_method": "FLAT",
                                   "id": "6173FC99331504AD1ACB5D697D54DA8C",
                                   "name": "Smartcards",
                                   "description": "Smartcards",
                                   "alternative_code": "SC"
                               },
                               "id": "EAC7A30429364176616CFEF5DF709941",
                               "description": "Smartcard 1",
                               "code": "Smartcard 1",
                               "alternative_code": "SC1"
                           }
                       },
                       "id": "A810E848559B4544A8970549EAD67696"
                   },
                   "id": "84317351CAD54F48AB3C1D8BC92F6572"
               }
           ],
           "one_time_services_distribution_set":
           [
           ],
           "owned_by_group":
           {
               "community_name": "Internal Community",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "name": "Main Group",
               "description": "Main Group",
               "alternative_code": "MG1"
           },
           "log_information":
           {
               "updated_date": "2015-04-22T12:43:25",
               "created_date": "2015-04-22T12:17:06",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               }
           },
           "subscription_address":
           {
               "postal_code": "123",
               "state": "Active",
               "street_number": "12",
               "country":
               {
                   "three_character_code": "USA",
                   "two_character_code": "US",
                   "id": "127",
                   "name": "UNITED STATES"
               },
               "street_name": "Street Name",
               "town_city": "City 1",
               "type": "Business",
               "id": "F8D86364842E49BBAFAB97665C54A027",
               "floor": 1,
               "area": "Area 1",
               "district": "District 1"
           },
           "termed_services_distribution_set":
           [
               {
                   "subscription_service":
                   {
                       "life_cycle_state": "EFFECTIVE",
                       "id": "B6E55DE01D614F19BE73B8910A6586EB",
                       "product":
                       {
                           "product_type":
                           {
                               "service_type": "TERMED",
                               "used_for_provisioning": true,
                               "classification": "SERVICES",
                               "composition_method": "FLAT",
                               "id": "600438B64B0F05AB3D020C902674949F",
                               "name": "Subscription services",
                               "description": "Subscription services",
                               "alternative_code": "SS"
                           },
                           "id": "CA3ACA47666F6CB6EECB3C15D1F0221A",
                           "description": "Cartoons 1",
                           "code": "Cartoons 1 ",
                           "alternative_code": "C1"
                       }
                   },
                   "provisioning_distributor":
                   {
                       "id": "B192D909D9B041F89FA8A197DC0F709A",
                       "name": "Main ",
                       "alternative_code": "M"
                   },
                   "id": "7A272669109245859D33DFBD274CBEF9"
               },
               {
                   "subscription_service":
                   {
                       "life_cycle_state": "EFFECTIVE",
                       "id": "61CF59F38DAB4101833330023A0F1392",
                       "product":
                       {
                           "product_type":
                           {
                               "service_type": "TERMED",
                               "used_for_provisioning": true,
                               "classification": "SERVICES",
                               "composition_method": "FLAT",
                               "id": "BC954969D3172372D498D3BB2BA590A0",
                               "name": "Subscription Packages",
                               "description": "Subscription main packages",
                               "alternative_code": "SP"
                           },
                           "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                           "description": "Gold Premium Package",
                           "code": "Gold",
                           "alternative_code": "GPP"
                       }
                   },
                   "provisioning_distributor":
                   {
                       "id": "B192D909D9B041F89FA8A197DC0F709A",
                       "name": "Main ",
                       "alternative_code": "M"
                   },
                   "id": "178C573D80194F06BC5BCFEAC7ED9356"
               }
           ],
           "life_cycle_state": "EFFECTIVE",
           "termed_services_set":
           [
               {
                   "life_cycle_state": "EFFECTIVE",
                   "id": "B6E55DE01D614F19BE73B8910A6586EB",
                   "product":
                   {
                       "product_type":
                       {
                           "service_type": "TERMED",
                           "used_for_provisioning": true,
                           "classification": "SERVICES",
                           "composition_method": "FLAT",
                           "id": "600438B64B0F05AB3D020C902674949F",
                           "name": "Subscription services",
                           "description": "Subscription services",
                           "alternative_code": "SS"
                       },
                       "id": "CA3ACA47666F6CB6EECB3C15D1F0221A",
                       "description": "Cartoons 1",
                       "code": "Cartoons 1 ",
                       "alternative_code": "C1"
                   }
               },
               {
                   "life_cycle_state": "EFFECTIVE",
                   "id": "61CF59F38DAB4101833330023A0F1392",
                   "product":
                   {
                       "product_type":
                       {
                           "service_type": "TERMED",
                           "used_for_provisioning": true,
                           "classification": "SERVICES",
                           "composition_method": "FLAT",
                           "id": "BC954969D3172372D498D3BB2BA590A0",
                           "name": "Subscription Packages",
                           "description": "Subscription main packages",
                           "alternative_code": "SP"
                       },
                       "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                       "description": "Gold Premium Package",
                       "code": "Gold",
                       "alternative_code": "GPP"
                   }
               }
           ],
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Neocleous",
                   "life_cycle_state": "FINANCIAL",
                   "title": "Mr",
                   "first_name": "Andreas",
                   "type": "PERSON",
                   "id": "6A83598F3331F9E57CD46A4C37D27D4B",
                   "name": "Andreas Neocleous",
                   "demographics":
                   {
                       "gender": "MALE",
                       "country_of_residence":
                       {
                           "three_character_code": "CYP",
                           "two_character_code": "CY",
                           "id": "181",
                           "name": "CYPRUS"
                       },
                       "name_day":
                       {
                           "month": 11,
                           "day": 1
                       },
                       "date_of_birth":
                       {
                           "month": 12,
                           "day": 31,
                           "year": 1968
                       },
                       "id_number": "974521"
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "ACR000521",
               "id": "0C8A1DE66B7A48788B48A1B698B97DB6",
               "name": "AN0091"
           },
           "one_time_services_set":
           [
           ],
           "type":
           {
               "log_information":
               {
                   "updated_date": "2015-02-20T16:40:42",
                   "created_date": "2014-06-25T15:44:04",
                   "created_by_unit":
                   {
                       "community_name": "Internal Community",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "name": "Admin Unit",
                       "group_name": "Main Group",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "updated_by_unit":
                   {
                       "community_name": "Internal Community",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "name": "Admin Unit",
                       "group_name": "Main Group",
                       "description": "r1",
                       "alternative_code": "MG"
                   }
               },
               "id": "1C81FBB1E5D90040F440ECE98D6A368D",
               "name": "United Kingdom",
               "description": "United Kingdom",
               "alternative_code": "UK"
           },
           "id": "F09554C878B24356AAB5811B1BA3E723",
           "installed_items_set":
           [
               {
                   "ownership_status": "RENTED_TO_CUSTOMER",
                   "installed_item":
                   {
                       "state": "EFFECTIVE",
                       "serial_number": "sc1000001217",
                       "id": "31EFF030A6C14069B60A4EC035D7A4A8",
                       "alternative_code": "sc1000001217",
                       "product":
                       {
                           "product_type":
                           {
                               "physical_good_type": "TRACEABLE",
                               "used_for_provisioning": true,
                               "classification": "PHYSICALGOODS",
                               "composition_method": "FLAT",
                               "id": "6173FC99331504AD1ACB5D697D54DA8C",
                               "name": "Smartcards",
                               "description": "Smartcards",
                               "alternative_code": "SC"
                           },
                           "id": "EAC7A30429364176616CFEF5DF709941",
                           "description": "Smartcard 1",
                           "code": "Smartcard 1",
                           "alternative_code": "SC1"
                       }
                   },
                   "id": "A810E848559B4544A8970549EAD67696"
               },
               {
                   "ownership_status": "RENTED_TO_CUSTOMER",
                   "installed_item":
                   {
                       "state": "EFFECTIVE",
                       "serial_number": "10109090",
                       "id": "CE0442B8BAA84B37A3E1D4A0C3B41995",
                       "alternative_code": "Dec10109090",
                       "product":
                       {
                           "product_type":
                           {
                               "physical_good_type": "TRACEABLE",
                               "used_for_provisioning": true,
                               "classification": "PHYSICALGOODS",
                               "composition_method": "FLAT",
                               "id": "B4A1396AE3D1384B304A0FEB22F7BA50",
                               "name": "Decoders",
                               "description": "Decoders",
                               "alternative_code": "D"
                           },
                           "id": "E8672BB71A9B1BD25E30705AC34D7D61",
                           "description": "Decoders 1",
                           "code": "Decoders 1",
                           "alternative_code": "D1"
                       }
                   },
                   "id": "341C8CFF3EB04E11A8EE339CCE380D4D"
               }
           ],
           "usage_services_set":
           [
           ]
       }
    }


...