GET usage_authorisation/show
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
...
Name | Type | Description |
token | String | The token retrieved from the login method |
| usage_authorisation_identifier (mandatory) | String | The unique identifier of the authorisation related to the usage service |
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 |
...
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|
GET
...
usage_
...
authorisation/list
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
This method returns information related with an accounts receivable's remaining usage allowance. Information related to a single accounts receivable is related with usage authorisation requests that were submitted against a specific subscription. Multiple usage authorisations are returned by each call.
Resource URL
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accountssubscription_receivable_identifier (mandatory)Accounts receivable identifier | Subscription Identifier | The identifier of the accounts receivable for which its remaining usage allowance subscription related with the usage authorisations that should be returned as a result. The allowed accounts receivable 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 |
...
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|
POST
...
usage_
...
authorisations/
...
create
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
This method adds members on a parent accounts receivable. Both of the accounts (parent and member) should be in an active life cycle state and should not be a member in another account group or a system account. The member account additionally should have the same currency as the parent account and have a different owner compared to the parent account ownercreates a usage authorisation. A single usage authorisation can be created by each call.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
parent_account (mandatory) | Accounts Receivable Identifier | The parent accounts receivable of the group within which the member account will be added. The available accounts receivable identifiers are the following:
| ||||||
funding_scope (mandatory) | String | The funding scope of the member accounts receivable to be added. Two options are available
| ||||||
(mandatory) | Accounts receivable object | The accounts receivable that will be added as a member in an account group. | ||||||
(mandatory) | Set of Product objects | The service or service type or service family that will be funded by the parent account | ||||||
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 |
...
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|
POST
...
usage_
...
authorisations/
...
cancel
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
This method removes a member account from a parent accounts receivable. 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.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
member_account_identifier (mandatory) | Accounts receivable identifier | The member accounts receivable that will be removed from the account group. The allowed accounts receivable 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 |
...
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|