Create CounterPricing

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/counterpricings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "pricingBands": [
    {
      "lowerLimit": 1,
      "fixedPrice": 123,
      "unitPrice": 123,
      "id": "<string>",
      "creditTypeId": "<string>"
    }
  ],
  "counterId": "<string>",
  "version": 123,
  "code": "<string>",
  "planId": "<string>",
  "planTemplateId": "<string>",
  "cumulative": true,
  "endDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "accountingProductId": "<string>",
  "runningTotalBillInAdvance": true,
  "proRateRunningTotal": true,
  "proRateAdjustmentDebit": true,
  "proRateAdjustmentCredit": true
}
'

{
  "id": "<string>",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "planId": "<string>",
  "planTemplateId": "<string>",
  "cumulative": true,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "code": "<string>",
  "description": "<string>",
  "accountingProductId": "<string>",
  "pricingBands": [
    {
      "lowerLimit": 1,
      "fixedPrice": 123,
      "unitPrice": 123,
      "id": "<string>",
      "creditTypeId": "<string>"
    }
  ],
  "counterId": "<string>",
  "runningTotalBillInAdvance": true,
  "proRateRunningTotal": true,
  "proRateAdjustmentDebit": true,
  "proRateAdjustmentCredit": true
}

POST

organizations

{orgId}

counterpricings

Create CounterPricing

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/counterpricings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "pricingBands": [
    {
      "lowerLimit": 1,
      "fixedPrice": 123,
      "unitPrice": 123,
      "id": "<string>",
      "creditTypeId": "<string>"
    }
  ],
  "counterId": "<string>",
  "version": 123,
  "code": "<string>",
  "planId": "<string>",
  "planTemplateId": "<string>",
  "cumulative": true,
  "endDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "accountingProductId": "<string>",
  "runningTotalBillInAdvance": true,
  "proRateRunningTotal": true,
  "proRateAdjustmentDebit": true,
  "proRateAdjustmentCredit": true
}
'

{
  "id": "<string>",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "planId": "<string>",
  "planTemplateId": "<string>",
  "cumulative": true,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "code": "<string>",
  "description": "<string>",
  "accountingProductId": "<string>",
  "pricingBands": [
    {
      "lowerLimit": 1,
      "fixedPrice": 123,
      "unitPrice": 123,
      "id": "<string>",
      "creditTypeId": "<string>"
    }
  ],
  "counterId": "<string>",
  "runningTotalBillInAdvance": true,
  "proRateRunningTotal": true,
  "proRateAdjustmentDebit": true,
  "proRateAdjustmentCredit": true
}

Authorizations

Authorization

string

header

required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

orgId

string

required

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

Body

application/json

startDate

string<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)

pricingBands

object[]

required

Minimum array length: 1

Show child attributes

counterId

string

required

UUID of the Counter used to create the pricing.

Minimum string length: 1

version

integer<int64>

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.

code

string

Unique short code for the Pricing.

Maximum string length: 80

planId

string

UUID of the Plan the Pricing is created for.

planTemplateId

string

UUID of the Plan Template the Pricing is created for.

cumulative

boolean

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.

endDate

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

description

string

Displayed on Bill line items.

Maximum string length: 200

accountingProductId

string

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

Required string length: 36

runningTotalBillInAdvance

boolean

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

proRateRunningTotal

boolean

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

proRateAdjustmentDebit

boolean

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

proRateAdjustmentCredit

boolean

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

Return the created CounterPricing

string

required

The UUID of the entity.

version

integer<int64>

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.

dtCreated

string<date-time>

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

dtLastModified

string<date-time>

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

createdBy

string

The ID of the user who created this item.

lastModifiedBy

string

The ID of the user who last modified this item.

planId

string

UUID of the Plan the Pricing is created for.

planTemplateId

string

UUID of the Plan Template the Pricing was created for.

cumulative

boolean

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.

startDate

string<date-time>

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

endDate

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

code

string

Unique short code for the Pricing.

description

string

Displayed on Bill line items.

accountingProductId

string

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

pricingBands

object[]

Show child attributes

counterId

string

UUID of the Counter used to create the pricing.

runningTotalBillInAdvance

boolean

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.

proRateRunningTotal

boolean

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.

proRateAdjustmentDebit

boolean

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.

proRateAdjustmentCredit

boolean

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.

List CounterPricing

Retrieve CounterPricing

⌘I

Getting Started

Endpoints

Create CounterPricing

Authorizations

Path Parameters

Body

Response