Retrieve Balance
Retrieve a specific Balance.
This endpoint returns the details of the specified Balance.
Path parameters
The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.
The unique identifier (UUID) of the Balance to retrieve.
Response
Returns the Balance
The UUID of the entity.
The version number:
- Create: On initial Create to insert a new entity, the version is set at 1 in the response.
- Update: On successful Update, the version is incremented by 1 in the response.
User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.
If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.
See Working with Custom Fields in the m3ter documentation for more information.
A unique short code assigned to the Balance.
The official name of the Balance.
A description of the Balance.
The unique identifier (UUID) for the end customer Account the Balance belongs to.
The financial value that the Balance holds.
The currency code used for the Balance amount. For example: USD, GBP or EUR.
The date (in ISO 8601 format) when the Balance becomes active.
The date (in ISO 8601 format) after which the Balance will no longer be active.
The maximum amount that can be carried over past the Balance end date and draw-down against for billing if there is an unused Balance amount remaining when the Balance end date is reached.
The end date (in ISO 8601 format) for the rollover grace period, which is the period that unused Balance amounts can be carried over beyond the specified Balance endDate and continue to be drawn-down against for billing.
A description for the bill line items for charges drawn-down against the Balance.
The percentage surcharge applied to overage charges (usage above the Balance).
A description for overage charges.
A list of Product IDs whose consumption charges due at billing can be drawn-down against the Balance amount.
A list of line item charge types that can draw-down against the Balance amount at billing.
The unique identifier (UUID) for a Contract on the Account the Balance has been added to.
Product ID that any Balance Consumed line items will be attributed to for accounting purposes.(Optional)
Product ID that any Balance Fees line items will be attributed to for accounting purposes.(Optional)
The date and time (in ISO 8601 format) when the Balance was first created.
The date and time (in ISO 8601 format) when the Balance was last modified.
The unique identifier (UUID) for the user who created the Balance.
The unique identifier (UUID) for the user who last modified the Balance.