Versions Compared

Old Version 9

changes.mady.by.user Former user

Saved on

compared with

New Version 10

changes.mady.by.user Joseph Ioannou

Saved on

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

Tip

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

GET subscriptions/actions/get_scheduled

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. AMEND_BILLING_TERMS
  4. CHANGE_SUBSCRIBER_ACCOUNT
  5. CHANGE_SUBSCRIPTION_LOCATION
  6. DEACTIVATE_SUBSCRIPTION
  7. END_SUBSCRIPTION_RESTING
  8. EXTEND_GRACE_PERIOD
  9. REMOVE_SERVICE
  10. REST_SUBSCRIPTION
  11. START_SERVICE
  12. STOP_SERVICE
  13. SWAP_SERVICE
  14. 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. ACTIVATE_SUBSCRIPTION
  2.  ADD_SERVICE / ADD_SERVICE_AS_DRAFT
  3.  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
  4. CHANGE_SUBSCRIBER / CHANGE_ACCOUNTS_RECEIVABLE
  5. CHANGE_SUBSCRIPTION_LOCATION
  6. DEACTIVATE_SUBSCRIPTION
  7. END_SUBSCRIPTION_RESTING
  8. EXTEND_GRACE_PERIOD
  9. REGRET_SERVICE / UNDO_ADD_SERVICE / REGRET_SERVICE / CANCEL_SERVICE
  10. REST_SUBSCRIPTION
  11. START_SERVICE
  12. STOP_SERVICE

  13. UPGRADE_SERVICE / DOWNGRADE_SERVICE / SWITCH_SERVICE

  14. REGRET_SUBSCRIPTION / CANCEL_SUBSCRIPTION

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

...

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

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

...