| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET subscriptions/configuration/types/list
This method returns the subscription types that are allowed to be used in the system. Multiple subscription types are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
accounts_receivable_identifier
(optional)
...
The identifier of the accounts receivable that will be owning the subscriptions related with the retrieved types. If specified then the subscription types are filtered against the subscription 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:
...
group_identifier
(optional)
...
The identifier of the group that will be providing the subscription type. The group is filtered against the subscription types' allowed organisational units. The allowed group identifier fields are the following:
...
unit_identifier
(optional)
...
The identifier of the unit that will be providing the subscription type. The unit is filtered against the subscription types' allowed organisational units. The allowed unit 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET subscriptions/configuration/billing_term_schemes/list
This method returns the billing term schemes that are allowed to be used by a specific type of subscription. Multiple billing term schemes are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_type_identifier
(mandatory)
...
The identifier of the type of the subscription that will be using the billing term schemes. 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET subscriptions/configuration/billing_term_schemes/price_plans/list
This method returns the price plans that can be applied on a subscription, considering the billing term scheme that will be used. Multiple price plans are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
billing_term_scheme_identifier
(mandatory)
...
The identifier of the billing term scheme that will provide the price plan. The allowed billing term scheme identifier fields are the following:
...
accounts_receivable_identifier
(optional)
...
The identifier of the accounts receivable that will be owning the subscription that will get the price plan. If specified then the price plans are filtered against the conditions to select the price plan, considering the specified accounts receivable. The allowed accounts receivable identifier fields are the following:
...
subscription_identifier
(optional)
...
The identifier of the subscription that will get the price plan. If specified then the price plans are filtered against the conditions to select the price plan, considering the specified subscription. The allowed subscription identifier fields are the following:
...
group_identifier
(optional)
...
The identifier of the group that will be providing the price plan. The group is filtered against the price plans' allowed organisational units. The allowed group identifier fields are the following:
...
unit_identifier
(optional)
...
The identifier of the unit that will be providing the price plan. The unit is filtered against the price plans' allowed organisational units. The allowed unit 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET subscriptions/configuration/provisioning_distributors/list
This method returns the provisioning distributors that are allowed to be used by a specific type of subscription. Multiple provisioning distributors are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_type_identifier
(mandatory)
...
The identifier of the type of the subscription that will be using the provisioning distributor. 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET subscriptions/configuration/action_types/list
This method returns the subscription action types and the related sub action types that are allowed to be used in the system. Multiple subscription action types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
behavior_code (optional) | String | The behavior code of the subscription action types that will be retrieved. If specified then only action types having the specified behavior code will be retrieved. The supported behavior codes are the following:
|
business_classification_code (optional) | String | The business classification code of the subscription sub action types that will be retrieved along with the action type. If specified then only sub action types having the specified business classification code will be retrieved. The supported business classification codes, per behavior code 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET subscriptions/configuration/allowed_actions/list
This method returns the subscription action types and the related sub action types that are allowed to be used in the system. Multiple subscription action types are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
behavior_code (optional) | String | The behavior code of the subscription action types that will be retrieved. If specified then only action types having the specified behavior code will be retrieved. The supported behavior codes are the following:
|
business_classification_code (optional) | String | The business classification code of the subscription sub action types that will be retrieved along with the action type. If specified then only sub action types having the specified business classification code will be retrieved. The supported business classification codes, per behavior code 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET subscriptions/configuration/become_subscriber/services/list
accounts receivable, subscription type, billing term scheme, mandatory / optional / provisioning distributor
GET subscriptions/configuration/add_services/services/list
subscription, mandatory / optional / provisioning distributor
GET subscriptions/configuration/swap_services/services/list
subscription, product, mandatory / optional / provisioning distributor
GET subscriptions/configuration/become_subscriber/installed_items/list
...