Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
BalanceChargeSchedule

Retrieve BalanceChargeSchedule

Retrieve a BalanceChargeSchedule for the given UUID.

get/organizations/{orgId}/balances/{balanceId}/balancechargeschedules/{id}

Path parameters

orgIdstring required

UUID of the organization

balanceIdstring required

UUID of the balance

idstring required

The UUID of the BalanceChargeSchedule to retrieve.

Response

Return the BalanceChargeSchedule

idstring required

The UUID of the entity.

versioninteger

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.
customFieldsobject

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.

balanceIdstring

The unique identifier (UUID) for the Balance this Balance Charge Schedule was created for.

namestring

The name of the Balance Charge Schedule.

codestring

Unique short code for the Balance Charge Schedule.

amountnumber

The amount of each Charge created by the Balance Charge Schedule.

unitsnumber

Number of units. If the Charge was created with amount only, then will be null.

unitPricenumber

Unit price. If the Charge was created with amount only, then will be null.

currencystring

The currency of the Charges created by the Balance Charge Schedule.

servicePeriodStartDatestring date-time

The service period start date (in ISO-8601 format) of the Balance Charge Schedule.

servicePeriodEndDatestring date-time

The service period end date (in ISO-8601 format) of the Balance Charge Schedule.

billEpochstring date

Specifies a billing cycle date (in ISO-8601 format) for when the first Bill is generated for Balance Charges created by the Schedule, and also acts as a reference for when in the Schedule period subsequent Bills are created for the defined billFrequency. If blank, then the relevant Epoch date from your Organization's configuration is used.

billFrequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY'

The period length of the Scheduled Balance Charge

billFrequencyIntervalinteger

How often Bills are issued. For example, if billFrequency is MONTHLY and billFrequencyInterval is 3, Bills are issued every three months.

billInAdvanceboolean

Specifies how Charges created by the Balance Charge Schedule are billed - either in arrears or in advance:

  • If false then billing is in arrears.
  • If true then billing is in advance.
chargeDescriptionstring required

The description for Charges created by the Balance Charge Schedule. Used on Bills for Charge line items.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Balance Charge Schedule was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Balance Charge Schedule was last modified.

createdBystring

The unique identifier (UUID) of the user who created the Balance Charge Schedule.

lastModifiedBystring

The unique identifier (UUID) for the user who last modified the Balance Charge Schedule.

nextRunstring date-time

The date and time (in ISO-8601 format) when the next Charge will be created by the Balance Charge Schedule.

previousRunstring date-time

The date and time (in ISO-8601 format) when the previous Charge was generated by the Balance Charge Schedule.