Sign in
Balances

Update Balance

Update a specific Balance.

This endpoint allows you to update the details of a specific Balance. The updated Balance details should be provided in the request body.

put/organizations/{orgId}/balances/{id}

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifier (UUID) of the Balance to update.

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed 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.

codestring required

Unique short code for the Balance.

namestring required

The official name for the Balance.

descriptionstring

A description of the Balance.

accountIdstring required

The unique identifier (UUID) for the end customer Account.

startDatestring date-time required

The date (in ISO 8601 format) when the Balance becomes active.

endDatestring date-time required

The date (in ISO 8601 format) after which the Balance will no longer be active for the Account.

Note: You can use the rolloverEndDate request parameter to define an extended grace period for continued draw-down against the Balance if any amount remains when the specified endDate is reached.

currencystring required

The currency code used for the Balance amount. For example: USD, GBP or EUR.

rolloverAmountnumber

The maximum amount that can be carried over past the Balance end date for draw-down at billing if there is any unused Balance amount when the end date is reached. Works with rolloverEndDate to define the amount and duration of a Balance "grace period". (Optional)

Notes:

  • If you leave rolloverAmount empty and only enter a rolloverEndDate, any amount left over after the Balance end date is reached will be drawn-down against up to the specified rolloverEndDate.
  • You must enter a rolloverEndDate. If you only enter a rolloverAmount without entering a rolloverEndDate, you'll receive an error when trying to create or update the Balance.
  • If you don't want to grant any grace period for outstanding Balance amounts, then do not use rolloverAmount and rolloverEndDate.
rolloverEndDatestring date-time

The end date (in ISO 8601 format) for the grace period during which unused Balance amounts can be carried over and drawn-down against at billing.

Note: Use rolloverAmount if you want to specify a maximum amount that can be carried over and made available for draw-down.

balanceDrawDownDescriptionstring

A description for the bill line items for draw-down charges against the Balance. (Optional).

overageSurchargePercentnumber double

Define a surcharge level, as a percentage of regular usage rating, applied to overages (usage charges that exceed the Balance amount). For example, if the regular usage rate is $10 per unit of usage consumed and overageSurchargePercent is set at 10%, then any usage charged above the original Balance amount is charged at $11 per unit of usage.

overageDescriptionstring

A description for Bill line items overage charges.

productIdsstring[]

Specify the Products whose consumption charges due at billing can be drawn-down against the Balance amount.

Note: If you don't specify any Products for Balance draw-down, by default the consumption charges for any Product the Account consumes will be drawn-down against the Balance amount.

lineItemTypesBalanceLineItemType[]

Specify the line item charge types that can draw-down at billing against the Balance amount. Options are:

  • "MINIMUM_SPEND"
  • "STANDING_CHARGE"
  • "USAGE"
  • "COUNTER_RUNNING_TOTAL_CHARGE"
  • "COUNTER_ADJUSTMENT_DEBIT"
  • AD_HOC

NOTE: If no charge types are specified, by default all types can draw-down against the Balance amount at billing.

contractIdstring

The unique identifier (UUID) of a Contract on the Account that the Balance will be added to.

consumptionsAccountingProductIdstring

Product ID that any Balance Consumed line items will be attributed to for accounting purposes.(Optional)

feesAccountingProductIdstring

Product ID that any Balance Fees line items will be attributed to for accounting purposes.(Optional)

Response

Returns the updated Balance

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.

codestring

A unique short code assigned to the Balance.

namestring

The official name of the Balance.

descriptionstring

A description of the Balance.

accountIdstring

The unique identifier (UUID) for the end customer Account the Balance belongs to.

amountnumber

The financial value that the Balance holds.

currencystring

The currency code used for the Balance amount. For example: USD, GBP or EUR.

startDatestring date-time

The date (in ISO 8601 format) when the Balance becomes active.

endDatestring date-time

The date (in ISO 8601 format) after which the Balance will no longer be active.

rolloverAmountnumber

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.

rolloverEndDatestring date-time

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.

balanceDrawDownDescriptionstring

A description for the bill line items for charges drawn-down against the Balance.

overageSurchargePercentnumber double

The percentage surcharge applied to overage charges (usage above the Balance).

overageDescriptionstring

A description for overage charges.

productIdsstring[]

A list of Product IDs whose consumption charges due at billing can be drawn-down against the Balance amount.

lineItemTypesBalanceLineItemType[]

A list of line item charge types that can draw-down against the Balance amount at billing.

contractIdstring

The unique identifier (UUID) for a Contract on the Account the Balance has been added to.

consumptionsAccountingProductIdstring

Product ID that any Balance Consumed line items will be attributed to for accounting purposes.(Optional)

feesAccountingProductIdstring

Product ID that any Balance Fees line items will be attributed to for accounting purposes.(Optional)

dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

The unique identifier (UUID) for the user who created the Balance.

lastModifiedBystring

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

Changes

Changed in 4 of the 10 revisions of this API.618

  • ac93d1a9e6d94See the full diff
    • ▲

      the request property allOf[subschema #3]/code became required

      request-property-became-required

    • ▲

      the request property allOf[subschema #3]/name became required

      request-property-became-required

    • ▲

      the allOf[subschema #3]/code request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[subschema #3]/name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0f92c877619f11See the full diff
    • ●

      added the new AD_HOC enum value to the allOf[subschema #3]/lineItemTypes/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new AD_HOC enum value to the request property allOf[subschema #3]/lineItemTypes/items/

      request-property-enum-value-added

  • 9f9e5f3dbde723See the full diff
    • ▲

      added AbstractRequestWithCustomFields to the request body allOf list

      request-body-all-of-added

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ○

      added the new optional request property allOf[subschema #2 -> subschema #3]/contractId

      new-optional-request-property

    • ○

      added AbstractResponseWithCustomFields to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      added the optional property allOf[subschema #2 -> subschema #3]/contractId to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d064a12d0d934See the full diff
    • ○

      added the new optional request property allOf[subschema #2]/consumptionsAccountingProductId

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #2]/feesAccountingProductId

      new-optional-request-property

    • ○

      added the optional property allOf[subschema #2]/consumptionsAccountingProductId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/feesAccountingProductId to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog