Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


 

Name

Type

Description

 

id

String

The ID of the retrieved usage authorisation

usage_authorisation_identifierStringThe unique identifier of the requested usage authorisation
life_cycle_stateStringThe life cycle state of the usage authorisation athorisation. The allowed life cycle states are BLOCKED, EXPIRED, CANCELLED and COMPLETED
authorisation_amountFloatThe amount of money that the account owner is authorised to consume requested for usage authorisation
authorisation_dateDateThe date on which the usage authorisation was provided to the account owner 
expiration_dateDateThe date on which the usage authorisation will get expired 
completed_dateDateThe date on which the usage authorisation was marked as completed upon an Add Service Usage subscription action 
cancellation_dateDateThe date on which the Usage Authorisation was cancelled 
accounts_receivableAccounts Receivable ObjectThe accounts receivable for which the Usage Authorisation was issued
subscriptionSubscription Object

The subscription for which the usage authorisation was providedissued and used

 
completed_by_actionSubscription Action ObjectThe Add Service Usage action which changed the Usage Authorisation's state to Complete 
cancelled_by_userUser ObjectThe user who cancelled the usage authorisation 
usage_authorisation_servicesSet of Usage Authorisation servicesThe 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
buy in advance request usage authorisation referred objectsbuy in advance request
usage authorisation referred objects
Referred Objects Response Data

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
subscription_short
subscription_short

Include Page
logsubscription_informationaction_shortlog
subscription_informationaction_short

Include Page
user_short
buy_in_advanceuser_short

Include Page
usage_authorisation_services_short
buyusage_in_advanceauthorisation_services_short