Versions Compared

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription Identifier

The identifier of the subscription related with the actions that will be retrieved. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

behavior_code

(optional)

String

The behavior code of the subscription actions that will be retrieved. If specified then only actions having the specified behavior code will be retrieved. The supported behavior codes are the following:

  1. ACTIVATESUBSCRIPTION
  2. ADDINSTALLEDITEM
  3. ADDSERVICEUSAGE
  4. ADDSERVICE
  5. AMENDBILLINGTERMS
  6. BECOMESUBSCRIBER
  7. BILLASOFDATE
  8. CHANGESUBRIBERACCOUNT
  9. CHANGESUBSCRIPTIONLOCATION
  10. DEACTIVATESUBSCRIPTION
  11. ENDSUBSCRIPTIONRESTING
  12. EXTENDGRACEPERIOD
  13. REMOVEINSTALLEDITEM
  14. REMOVESERVICE
  15. RESTSUBSCRIPTION
  16. STARTSERVICE
  17. STOPSERVICE
  18. SWAPINSTALLEDITEM
  19. SWAPSERVICE
  20. TERMINATESUBSCRIPTIONACTIVATE_SUBSCRIPTION
  21. ADD_INSTALLED_ITEM
  22. ADD_SERVICE_USAGE
  23. ADD_SERVICE
  24. AMEND_BILLING_TERMS
  25. BECOME_SUBSCRIBER
  26. BILL_AS_OF_DATE
  27. CHANGE_SUBSCRIBER_ACCOUNT
  28. CHANGE_SUBSCRIPTION_LOCATION
  29. DEACTIVATE_SUBSCRIPTION
  30. END_SUBSCRIPTION_RESTING
  31. EXTEND_GRACE_PERIOD
  32. REMOVE_INSTALLED_ITEM
  33. REMOVE_SERVICE
  34. REST_SUBSCRIPTION
  35. START_SERVICE
  36. STOP_SERVICE
  37. SWAP_INSTALLED_ITEM
  38. SWAP_SERVICE
  39. TERMINATE_SUBSCRIPTION

business_classification_code

(optional)

String

The business classification code of the subscription actions that will be retrieved along with the action type. If specified then only actions having the specified business classification code will be retrieved. The supported business classification codes, per behavior code are the following:

  1. ACTIVATESUBSCRIPTION
  2.  ADDINSTALLEDITEM
  3.  ADDSERVICEUSAGE
  4.  ADDSERVICE / ADDSERVICEASDRAFT
  5.  NEWBINDINGPERIODTERMS / RENEWEDBINDINGPERIODTERMS / EXTENDEDBINDINGPERIODTERMS / ADJUSTEDBINDINGPERIODTERMS / CANCELEDBINDINGPERIODTERMS / NOBINDINGPERIODTERMCHANGES
  6. CREATEACTIVATESUBSCRIPTION / CREATEDRAFTSUBSCRIPTION
  7. NORMAL
  8. CHANGESUBSCRIBER / CHANGEACCOUNTSRECEIVABLE
  9. CHANGESUBSCRIPTIONLOCATION
  10. DEACTIVATESUBSCRIPTION
  11. ENDSUBSCRIPTIONRESTING
  12. EXTENDGRACEPERIOD
  13. REMOVEINSTALLEDITEM / UNDOADDINSTITEM
  14. REGRETSERVICE / UNDOADDSERVICE / REGRETSERVICE / CANCELSERVICE
  15. RESTSUBSCRIPTION
  16. STARTSERVICE
  17. STOPSERVICE
  18. SWAPINSTALLEDITEM
  19. UPGRADESERVICE / DOWNGRADESERVICE / SWITCHSERVICE

  20. REGRETSUBSCRIPTION / CANCELSUBSCRIPTIONACTIVATE_SUBSCRIPTION
  21.  ADD_INSTALLED_ITEM
  22.  ADD_SERVICE_USAGE
  23.  ADD_SERVICE / ADD_SERVICE_AS_DRAFT
  24.  NEW_BINDING_PERIOD_TERMS / RENEWED_BINDING_PERIOD_TERMS / EXTENDED_BINDING_PERIOD_TERMS / ADJUSTED_BINDING_PERIOD_TERMS / CANCELED_BINDING_PERIOD_TERMS / NO_BINDING_PERIOD_TERM_CHANGES
  25. CREATE_ACTIVATE_SUBSCRIPTION / CREATE_DRAFT_SUBSCRIPTION
  26. NORMAL
  27. CHANGE_SUBSCRIBER / CHANGE_ACCOUNTS_RECEIVABLE
  28. CHANGE_SUBSCRIPTION_LOCATION
  29. DEACTIVATE_SUBSCRIPTION
  30. END_SUBSCRIPTION_RESTING
  31. EXTEND_GRACE_PERIOD
  32. REMOVE_INSTALLED_ITEM / UNDO_ADD_INSTALLED_ITEM
  33. REGRET_SERVICE / UNDO_ADD_SERVICE / REGRET_SERVICE / CANCEL_SERVICE
  34. REST_SUBSCRIPTION
  35. START_SERVICE
  36. STOP_SERVICE
  37. SWAP_INSTALLED_ITEM
  38. UPGRADE_SERVICE / DOWNGRADE_SERVICE / SWITCH_SERVICE

  39. REGRET_SUBSCRIPTION / CANCEL_SUBSCRIPTION

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

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_action_identifier

(mandatory)

Subscription Action identifier

The subscription action to be cancelled. The allowed subscription action identifier fields are the following:

Include Page
V4:subscription_action_identifier
V4:subscription_action_identifier

...