Versions Compared

Key

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

This method returns the subscription action which are scheduled to be executed and are in life cycle state Scheduled. Multiple subscription actions are returned by each call

...

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. ADD_SERVICE
  2. START_SERVICE
  3. STOP_SERVICE
  4. SWAP_SERVICE
  5. REMOVE_SERVICE
  6. ADD_SERVICE_USAGE 
  7. AMEND_BUNDLED_SERVICE
  8. ACTIVATE_SUBSCRIPTION
  9. DEACTIVATE_SUBSCRIPTION
  10. SHORT_TERM_ACTIVATION
  11. SHORT_TERM_DEACTIVATION
  12. AMEND_BILLING_TERMS
  13. AMEND_SERVICES_INSTALLED_ITEMS
  14. REST_SUBSCRIPTION
  15. TERMINATE_SUBSCRIPTION
  16. REPLACE_SUBSCRIPTION
  17. SWAP_PACKAGE

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.  ADDADD_SERVICE
  2. ADD_SERVICE_AS_DRAFT
  3. START_SERVICE
  4. STOP_SERVICE
  5. ADD_SERVICE_USAGE 
  6. AMEND_BUNDLED_SERVICE
  7. UPGRADE_SERVICE
  8. DOWNGRADE_SERVICE
  9. SWITCH_SERVICE
  10. REGRET_SERVICE
  11. UNDO_ADD_SERVICE
  12. CANCEL_SERVICE
  13. ACTIVATE_SUBSCRIPTION
  14. DEACTIVATE_SUBSCRIPTION
  15. SHORT_TERM_ACTIVATION
  16. SHORT_TERM_DEACTIVATION
  17. 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
  18. REST_SUBSCRIPTION
  19. REGRET_SUBSCRIPTION
  20. CANCEL_SUBSCRIPTION
  21. REPLACE_SUB_PACK_TO_FLEX
  22. REPLACE_SUB_FLEX_TO_PACK
  23. UPGRADE_PACKAGE
  24. DOWNGRADE_PACKAGE
  25. SWITCH_PACKAGE

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

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

...