...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET usage_authorisation/show
This method returns information related with a usage authorisation request. A single Usage Authorisation is returned by each call
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_authorisation_identifier (mandatory) | Usage Authorisation Identifier | The identifier of the usage authorisation. The allowed alert Identifier fields are the following:
| ||||||
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 |
...
GET usage_authorisation/list
...
This method returns information related with usage authorisation requests that were submitted against a specific subscription. Multiple usage authorisations 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 usage authorisations that should be returned as a result. The allowed subscription identifier fields are the following:
| ||||||
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 |
...
POST usage_authorisations/create
...
This method creates a usage authorisation. A single usage authorisation can be created 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 usage authorisation to be created. The allowed subscription identifier fields are the following:
| ||||||
authorisation_amount (mandatory) | Float | The amount of money the subscriber requests to be authorised | ||||||
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 |
...
POST usage_authorisations/cancel
...
This method cancels an existing usage authorisation. This method can be used only if the specified usage authorisation's life cycle state is set to Blocked. A single usage authorisation can be cancelled by each call.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_authorisation_identifier (mandatory) | String | The identifier of the usage authorisation to be cancelled. The allowed usage authorisation Identifier fields are the following:
| ||||||
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 |
...