| Excerpt |
|---|
It previews the bill of one subscription based on a specific as of date |
...
Name | Type | Description | ||||||||||
token | String | The token retrieved from the login method | ||||||||||
| subscription_identifier (semi-optional) | Identifier | The identifier of the subscription that should be previewed. The allowed subscription identifier fields are the following:
| ||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:
| ||||||||||
as_of_date (mandatory) | Date | The date that will be used to bill the subscription
| ||||||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
Tip |
| |||||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
Tip |
| |||||||||
transaction_reference_number (optional) | String | The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.
| ||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||
performed_on (optional) | Date | The date that the action was actually performed Tip |
| |||||||||
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.
...