Versions Compared

Old Version 9

changes.mady.by.user p_demou

Saved on

compared with

New Version 10

changes.mady.by.user Georgia Kountouri

Saved on

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 action types 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. ACTIVATE_SUBSCRIPTION
  2. ADD_SERVICE
  3. AMENDSTART_BILLING_TERMSSERVICECHANGE
  4. STOP_SUBSCRIBER_ACCOUNTSERVICECHANGE
  5. SWAP_SUBSCRIPTION_LOCATIONSERVICEDEACTIVATE
  6. REMOVE_SUBSCRIPTIONSERVICEEND
  7. ADD_SUBSCRIPTIONSERVICE_RESTINGUSAGE 
  8. EXTENDAMEND_GRACEBUNDLED_PERIODSERVICE
    REMOVE
  9. ACTIVATE_SERVICESUBSCRIPTION
  10. RESTDEACTIVATE_SUBSCRIPTIONSTART
  11. SHORT_SERVICESTOPTERM_SERVICEACTIVATIONSWAP
  12. SHORT_SERVICETERMINATETERM_SUBSCRIPTIONDEACTIVATION
business
  1. AMEND_
classification_
  1. BILLING_TERMS
  2. AMEND_SERVICES_INSTALLED_ITEMS
  3. REST_SUBSCRIPTION
  4. TERMINATE_SUBSCRIPTION
  5. REPLACE_SUBSCRIPTION
  6. 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:

ACTIVATE_SUBSCRIPTION

  1.  ADD_SERVICE /
  2. ADD_SERVICE_AS_DRAFT NEW
  3. START_BINDING_PERIOD_TERMS / RENEWED_BINDING_PERIOD_TERMS / EXTENDEDSERVICE
  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 / ADJUSTEDRENEWED_BINDING_PERIOD_TERMS / CANCELEDEXTENDED_BINDING_PERIOD_TERMS / NOADJUSTED_BINDING_PERIOD_TERM_CHANGES
  18. CHANGE_SUBSCRIBER / CHANGE_ACCOUNTS_RECEIVABLE
  19. CHANGE_SUBSCRIPTION_LOCATION
  20. DEACTIVATE_SUBSCRIPTION
  21. END_SUBSCRIPTION_RESTING
  22. EXTEND_GRACE_PERIOD
  23. REGRET_SERVICE / UNDO_ADD_SERVICE / REGRET_SERVICE / CANCEL_SERVICE
  24. REST_SUBSCRIPTION
  25. START_SERVICE
  26. STOP_SERVICE

  27. UPGRADE_SERVICE / DOWNGRADE_SERVICE / SWITCH_SERVICE

  28. REGRET_SUBSCRIPTION / CANCEL_SUBSCRIPTIONTERMS / CANCELED_BINDING_PERIOD_TERMS / NO_BINDING_PERIOD_TERM_CHANGES

  29. REST_SUBSCRIPTION
  30. REGRET_SUBSCRIPTION
  31. CANCEL_SUBSCRIPTION
  32. REPLACE_SUB_PACK_TO_FLEX
  33. REPLACE_SUB_FLEX_TO_PACK
  34. UPGRADE_PACKAGE
  35. DOWNGRADE_PACKAGE
  36. 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

...