Versions Compared

Old Version 6

changes.mady.by.user Former user

Saved on

compared with

New Version 7

changes.mady.by.user Former user

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

...

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_INSTALLED_ITEM
  3. ADD_SERVICE_USAGE
  4. ADD_SERVICE
  5. AMEND_BILLING_TERMS
  6. BECOME_SUBSCRIBER
  7. BILL_AS_OF_DATE
  8. CHANGE_SUBSCRIBER_ACCOUNT
  9. CHANGE_SUBSCRIPTION_LOCATION
  10. DEACTIVATE_SUBSCRIPTION
  11. END_SUBSCRIPTION_RESTING
  12. EXTEND_GRACE_PERIOD
  13. REMOVE_INSTALLED_ITEM
  14. REMOVE_SERVICE
  15. REST_SUBSCRIPTION
  16. START_SERVICE
  17. STOP_SERVICE
  18. SWAP_INSTALLED_ITEM
  19. SWAP_SERVICE
  20. 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_INSTALLED_ITEM
  3.  ADD_SERVICE_USAGE
  4.  ADD_SERVICE / ADD_SERVICE_AS_DRAFT
  5.  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
  6. CREATE_ACTIVATE_SUBSCRIPTION / CREATE_DRAFT_SUBSCRIPTION
  7. NORMAL
  8. CHANGE_SUBSCRIBER / CHANGE_ACCOUNTS_RECEIVABLE
  9. CHANGE_SUBSCRIPTION_LOCATION
  10. DEACTIVATE_SUBSCRIPTION
  11. END_SUBSCRIPTION_RESTING
  12. EXTEND_GRACE_PERIOD
  13. REMOVE_INSTALLED_ITEM / UNDO_ADD_INSTALLED_ITEM
  14. REGRET_SERVICE / UNDO_ADD_SERVICE / REGRET_SERVICE / CANCEL_SERVICE
  15. REST_SUBSCRIPTION
  16. START_SERVICE
  17. STOP_SERVICE
  18. SWAP_INSTALLED_ITEM

  19. UPGRADE_SERVICE / DOWNGRADE_SERVICE / SWITCH_SERVICE

  20. 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

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token": "BAB61C7163984029A3E4877F727B145A",
  "subscription_action_identifier":{"id":"1F46975162B043F793845CF623DB30C3"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
   {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "scheduled_date": "2015-03-06T00:00:00",
        "action_type": null,
        "submitted_on": "2015-03-05T12:15:06",
        "sub_action_type": null,
        "business_classification_code": "REST_SUBSCRIPTION",
        "number": "652",
        "executed_on": null,
        "life_cycle_state": "CANCELLED",
        "performed_by":
        {
            "person_name": "mpadministrator",
            "username": "mpadministrator",
            "id": "1"
        },
        "behavior_code": "REST_SUBSCRIPTION",
        "submitted_by":
        {
            "person_name": "mpadministrator",
            "username": "mpadministrator",
            "id": "1"
        },
        "id": "1F46975162B043F793845CF623DB30C3",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou62",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Marios",
                    "name": "Marios Ioannou62",
                    "id": "ED341F6221594379885524F4881A0644",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "440",
                "name": "mar62",
                "id": "DF02CC62D9DE76DEB5C6B32BEBCBFDF1"
            },
            "life_cycle_state": "NOT_EFFECTIVE",
            "number": "S60246",
            "type":
            {
                "name": "Digital",
                "id": "BF666FA094CA88E36BA6AE1F924C69F9",
                "description": null,
                "alternative_code": "DST"
            },
            "id": "B4BB0997B5B62B1FAB5297E82AE14E4A"
        },
        "performed_on": "2015-03-05T12:10:02"
    }
}