GET subscriptions/installed_items/configuration/become_subscriber/list
This method returns the the physical goods that can be used to create a new subscription of a specific type. Multiple physical goods are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
subscription_type_identifier (mandatory) | Subscription Type Identifier | The identifier of the the subscription type that will be used in the subscription. The allowed subscription type 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 physical goods. If specified then the physical goods will be filtered based on the specified provisioning distributor. The allowed provisioning distributor identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The identifier of the accounts receivable that will be owning the subscriptions related with the specified type. If specified then the subscription physical goods are filtered against the subscription physical goods restrictions specified in the active subscription definition, considering the subscriptions that are already owned by the specified accounts receivable. The allowed accounts receivable 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 subscription type physical good |
Product Object | The actual product provided by the subscription type physical good |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": null,
"description": null,
"code": "OK"
},
"data": [
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
},
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "E8672BB71A9B1BD25E30705AC34D7D61",
"description": "Decoders 1",
"code": "Decoders 1",
"alternative_code": "D1"
},
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Smartcards",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
},
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Smartcards",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
}
]
}
GET subscriptions/installed_items/configuration/add_installed_items/list
This method returns the the physical goods that can be added on an existing subscription. Multiple physical goods 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 physical goods will be added on. The subscription physical goods are filtered against the subscription physical goods 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 physical goods. If specified then the physical goods will be filtered based on the specified provisioning distributor. The allowed provisioning distributor 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 subscription type physical good |
Product Object | The actual product provided by the subscription type physical good |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": null,
"description": null,
"code": "OK"
},
"data": [
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "12A61F321368703D77C48A0A085D9B7D",
"description": "Decoders 2",
"code": "Decoders 2",
"alternative_code": "D2"
},
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "E8672BB71A9B1BD25E30705AC34D7D61",
"description": "Decoders 1",
"code": "Decoders 1",
"alternative_code": "D1"
},
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Smartcards",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
},
{
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Smartcards",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
}
]
}