GET subscriptions/configuration/behavior_codes/list
This method returns a list of behavior codes and business classification codes that can be applied on a specific subscription, subscription service or subscription installed item, considering their life cycle state. Multiple behavior codes are returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
subscription_identifier (semi-optional) | Subscription Identifier | The identifier of the subscription that the action will be applied on. The allowed subscription identifier fields are the following:
| |||||||||
subscription_service_id (semi-optional) | String | The subscription service that the action will be applied on. | |||||||||
subscription_installed_item_id (semi-optional) | String | The subscription installed item that the action will be applied on. | |||||||||
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.
Response Data
Name | Type | Description |
|---|---|---|
behavior_code | String | The applicable behavior code. The supported behavior codes are the following:
|
Set of Business Classification Codes Object | The applicable business classification codes |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": null,
"description": null,
"code": "OK"
},
"data": [
{
"behavior_code": "DEACTIVATE_SUBSCRIPTION",
"business_classification_codes_set": [
{
"business_classification_code": "DEACTIVATE_SUBSCRIPTION"
}
]
},
{
"behavior_code": "TERMINATE_SUBSCRIPTION",
"business_classification_codes_set": [
{
"business_classification_code": "REGRET_SUBSCRIPTION"
},
{
"business_classification_code": "CANCEL_SUBSCRIPTION"
}
]
},
{
"behavior_code": "REST_SUBSCRIPTION",
"business_classification_codes_set": [
{
"business_classification_code": "REST_SUBSCRIPTION"
}
]
},
{
"behavior_code": "CHANGE_SUBSCRIBER_ACCOUNT",
"business_classification_codes_set": [
{
"business_classification_code": "CHANGE_SUBSCRIBER"
},
{
"business_classification_code": "CHANGE_ACCOUNTS_RECEIVABLE"
}
]
},
{
"behavior_code": "AMEND_BILLING_TERMS",
"business_classification_codes_set": [
{
"business_classification_code": "ADJUSTED_BINDING_PERIOD_TERMS"
},
{
"business_classification_code": "CANCELED_BINDING_PERIOD_TERMS"
},
{
"business_classification_code": "EXTENDED_BINDING_PERIOD_TERMS"
},
{
"business_classification_code": "NEW_BINDING_PERIOD_TERMS"
},
{
"business_classification_code": "NO_BINDING_PERIOD_TERM_CHANGES"
},
{
"business_classification_code": "RENEWED_BINDING_PERIOD_TERMS"
}
]
},
{
"behavior_code": "CHANGE_SUBSCRIPTION_LOCATION",
"business_classification_codes_set": [
{
"business_classification_code": "CHANGE_SUBSCRIPTION_LOCATION"
}
]
},
{
"behavior_code": "EXTEND_GRACE_PERIOD",
"business_classification_codes_set": [
{
"business_classification_code": "EXTEND_GRACE_PERIOD"
}
]
}
]
}