Versions Compared

Key

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

Available from CRM.COM R12.0.0

 

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

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

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

promotion_code

(optional)

StringThe promotion code that should be used during the registration. The promotion code can be retrieved through the promotions/list Web API method

channel

(optional)

String

The channel that the registration was done through which can be one of the following:

  • WEB
  • STORE
  • MOBILE
  • BROADBAND
  • OTHER

validity_duration

(optional)

IntegerThe validity duration of the netflix  token, specified in seconds, The duration can be up to 24 hours.

customer_first_name

(optional)

String The first name of the customer

customer_last_name

(optional)

String The last name of the customer

customer_address

(optional)

Address Object The address of the customer

customer_email

(optional)

Email Object The email of the customer

customer_phone

(optional)

Phone Object The phone of the customer

...

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "token":"737C2CC402644029BA7827E41B932C79",
    "billing_system_customer_identifier":"pci123"
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

POST netflix/subscriptions/unsuspend

This method unsuspends an existing netflix subscriber. A single subscription can be suspended through each call 

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

Response Data

Not applicable

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

POST netflix/subscriptions/cancel

...

    {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

POST netflix/subscriptions/unsuspend

This method unsuspends an existing netflix subscriber. A single subscription can be suspended through each call 

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

Response Data

Not applicable

Examples

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "token":"737C2CC402644029BA7827E41B932C79",
    "billing_system_customer_identifier":"pci123"   
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
     {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

POST netflix/subscriptions/cancel

This method cancels an existing netflix subscriber. A single subscription can be suspended through each call 

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

Response Data

Not applicable

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "token":"737C2CC402644029BA7827E41B932C79",
    "billing_system_customer_identifier":"pci123"
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
     {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

GET netflix/charges/list

This method returns the netflix charges which were processed by CRM.COM and were not acknowledged by the operator which are applicable for the operator, starting from the oldest charge. Retrieved charges should be acknowledged through the charges/acknowledge Web API in order to be excluded by any subsequent calls . Up to 50 charges can be returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

number_of_results

(mandatory)

NumberThe number of results that can be retrieved through each call. The maximum number of results can be 50. The oldest charges are retrieved fist

offset

(mandatory)

NumberIt defines the number of charges that should be skipped from the results. During the first call it should be set to 0 and then it should be increased based on the number of results that were retrieved

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

acknowledged_charges_set

(mandatory)

Set of Acknowledged Netflix Charge Objects

The netflix charges that were received by the operator and were acknowledged. Acknowledged charges will not be included in any subsequent calls of the charges/list Web API.

Maximum 50 charges can be acknowledged through each call

...