v10

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

CounterPricing

Update CounterPricing

Update CounterPricing for the given UUID.

Note: Either planId or planTemplateId request parameters are required for this call to be valid. If you omit both, then you will receive a validation error.

put/organizations/{orgId}/counterpricings/{id}

Path parameters

orgIdstring required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

idstring required

The UUID of the CounterPricing 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.

codestring

Unique short code for the Pricing.

planIdstring

UUID of the Plan the Pricing is created for.

planTemplateIdstring

UUID of the Plan Template the Pricing is created for.

cumulativeboolean

Controls whether or not charge rates under a set of pricing bands configured for a Pricing are applied according to each separate band or at the highest band reached.

(Optional). The default value is FALSE.

When TRUE, at billing charge rates are applied according to each separate band.
When FALSE, at billing charge rates are applied according to highest band reached.

NOTE: Use the cumulative parameter to create the type of Pricing you require. For example, for Tiered Pricing set to TRUE; for Volume Pricing, set to FALSE.

startDatestring date-time required

The start date (in ISO-8601 format) for when the Pricing starts to be active for the Plan of Plan Template.(Required)

endDatestring date-time

The end date (in ISO-8601 format) for when the Pricing ceases to be active for the Plan or Plan Template.

(Optional) If not specified, the Pricing remains active indefinitely.

descriptionstring

Displayed on Bill line items.

accountingProductIdstring

Optional Product ID this Pricing should be attributed to for accounting purposes

counterIdstring required

UUID of the Counter used to create the pricing.

runningTotalBillInAdvanceboolean

The default value is TRUE.

When TRUE, running totals are billed at the start of each billing period.
When FALSE, running totals are billed at the end of each billing period.

(Optional).

proRateRunningTotalboolean

The default value is TRUE.

When TRUE, counter running total charges are prorated and are billed according to the number of days in billing period.
When FALSE, counter running total charges are not prorated and are billed for the entire billing period.

(Optional).

proRateAdjustmentDebitboolean

The default value is TRUE.

When TRUE, counter adjustment debits are prorated and are billed according to the number of days in billing period.
When FALSE, counter adjustment debits are not prorated and are billed for the entire billing period.

(Optional).

proRateAdjustmentCreditboolean

The default value is TRUE.

When TRUE, counter adjustment credits are prorated and are billed according to the number of days in billing period.
When FALSE, counter adjustment credits are not prorated and are billed for the entire billing period.

(Optional).

Response

Returns the updated CounterPricing

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.

dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

planIdstring

UUID of the Plan the Pricing is created for.

planTemplateIdstring

UUID of the Plan Template the Pricing was created for.

cumulativeboolean

Controls whether or not charge rates under a set of pricing bands configured for a Pricing are applied according to each separate band or at the highest band reached.

The default value is TRUE.

When TRUE, at billing charge rates are applied according to each separate band.
When FALSE, at billing charge rates are applied according to highest band reached.

startDatestring date-time

The start date (in ISO-8601 format) for when the Pricing starts to be active for the Plan of Plan Template.

endDatestring date-time

The end date (in ISO-8601 format) for when the Pricing ceases to be active for the Plan or Plan Template.

If not specified, the Pricing remains active indefinitely.

codestring

Unique short code for the Pricing.

descriptionstring

Displayed on Bill line items.

accountingProductIdstring

counterIdstring

UUID of the Counter used to create the pricing.

runningTotalBillInAdvanceboolean

The default value is TRUE.

When TRUE, running totals are billed at the start of each billing period.
When FALSE, running totals are billed at the end of each billing period.

proRateRunningTotalboolean

The default value is TRUE.

When TRUE, counter running total charges are prorated and are billed according to the number of days in billing period.
When FALSE, counter running total charges are not prorated and are billed for the entire billing period.

proRateAdjustmentDebitboolean

The default value is TRUE.

When TRUE, counter adjustment debits are prorated and are billed according to the number of days in billing period.
When FALSE, counter adjustment debits are not prorated and are billed for the entire billing period.

proRateAdjustmentCreditboolean

The default value is TRUE.

When TRUE, counter adjustment credits are prorated and are billed according to the number of days in billing period.
When FALSE, counter adjustment credits are not prorated and are billed for the entire billing period.