Tip |
---|
Available from CRM.COM R12.0.0 |
Table of Contents | ||
---|---|---|
|
...
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) | String | The identifier of the customer as defined in the billing system managed by the caller |
promotion_code (optional) | String | The 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:
|
validity_duration (optional) | Integer | The 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 |
(optional) | Address Object | The address of the customer |
(optional) | Email Object | The email of the customer |
(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) | String | The identifier of the customer as defined in the billing system managed by the caller |
...
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
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) | String | The identifier of the customer as defined in the billing system managed by the caller |
Response Data
Not applicable
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST netflix/subscriptions/cancel
...
|
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) | String | The identifier of the customer as defined in the billing system managed by the caller |
Response Data
Not applicable
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Response:
theme | Confluence |
---|---|
language | javascript |
linenumbers | true |
1 |
HTTP Method: POST
Request:
Body:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"token":"737C2CC402644029BA7827E41B932C79",
"billing_system_customer_identifier":"pci123"
} |
Response:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"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) | String | The identifier of the customer as defined in the billing system managed by the caller |
Response Data
Not applicable
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
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) | Number | The 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) | Number | It 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 |
(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 |
...