...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
GET subscriptions/list
This method returns information related with subscriptions owned by the same accounts receivable. Multiple subscription is returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
accounts_receivable_identifier (semi-optional) | Accounts receivable identifier | The identifier of the accounts receivable owning the subscriptions that will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||||
wallet_identifier (semi-optional) | Wallet identifier | The identifier of the wallet elated with the subscription that should be returned as a result. The allowed wallet identifier fields are the following:
| ||||||||
type_identifier (optional) | Subscription type identifier | The identifier of the subscription type related with the subscriptions that will be retrieved. The allowed subscription type identifier fields are the following:
| ||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|