Name | Type | Description | |
|---|
id | String | The ID of the retrieved usage authorisation |
| usage_authorisation | _identifier | String | The unique identifier of the requested usage authorisation |
| life_cycle_state | String | The life cycle state of the usage authorisation. the The allowed life cycle states are BLOCKED, EXPIRED, CANCELLED and COMPLETED | |
| authorisation_amount | Float | The amount of money requested for usage authorisation |
| authorisation_date | Date | The date on which the usage authorisation was provided |
| expiration_date | Date | The date on which the usage authorisation will get expired | |
| completed_date | Date | The date on which the usage authorisation was marked as completed upon an Add Service Usage subscription action | |
| cancellation_date | Date | The date on which the Usage Authorisation was cancelled |
| accounts_receivable | Accounts Receivable Object | The accounts receivable for which the Usage Authorisation was issued |
| subscription | Subscription Object | The subscription for which the usage authorisation was submitted issued and used
|
| completed_by_action | Subscription Action Object | The Add Service Usage action which changed the Usage Authorisation's state to Complete |
| cancelled_by_user | User Object | The user who cancelled the usage authorisation | |
| usage_authorisation_services | Set of Usage Authorisation services | The usage services for which the usage authorisation amount's was authorised along with the maximum amount and maximum usage allowance limits at that time | |
| Anchor |
|---|
| usage authorisation referred objects |
|---|
| usage authorisation referred objects |
|---|
|
Referred Objects Response Data
| Include Page |
|---|
| accounts_receivable_short |
|---|
| accounts_receivable_short |
|---|
|
| Include Page |
|---|
| subscription_short |
|---|
| subscription_short |
|---|
|
...
| Include Page |
|---|
| userusage_authorisation_services_shortuser |
|---|
| usage_authorisation_services_short |
|---|
|