Sign in
Pricing

Create Pricing

Create a new Pricing.

Notes:

  • Exactly one of planId or planTemplateId request parameters are required for this call to be valid. If you omit both, then you will receive a validation error.
  • Exactly one of aggregationId or compoundAggregationId request parameters are required for this call to be valid. If you omit both, then you will receive a validation error.
post/organizations/{orgId}/pricings

Path parameters

orgIdstring required

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

Request body

aggregationIdstring

UUID of the Aggregation used to create the Pricing. Use this when creating a Pricing for a segmented aggregation.

compoundAggregationIdstring

UUID of the Compound Aggregation used to create the Pricing.

type'DEBIT' | 'PRODUCT_CREDIT' | 'GLOBAL_CREDIT'

  • DEBIT. Default setting. The amount calculated using the Pricing is added to the bill as a debit.

  • PRODUCT_CREDIT. The amount calculated using the Pricing is added to the bill as a credit (negative amount). To prevent negative billing, the bill will be capped at the total of other line items for the same Product.

  • GLOBAL_CREDIT. The amount calculated using the Pricing is added to the bill as a credit (negative amount). To prevent negative billing, the bill will be capped at the total of other line items for the entire bill, which might include other Products the Account consumes.

segmentobject

Specifies the segment value which you are defining a Pricing for using this call:

  • For each segment value defined on a Segmented Aggregation you must create a separate Pricing and use the appropriate aggregationId parameter for the call.
  • If you specify a segment value that has not been defined for the Aggregation, you'll receive an error.
  • If you've defined segment values for the Aggregation using a single wildcard or multiple wildcards, you can create Pricing for these wildcard segment values also.

For more details on creating Pricings for segment values on a Segmented Aggregation using this call, together with some examples, see the Using API Call to Create Segmented Pricings in our User Documentation.

tiersSpanPlanboolean

The default value is FALSE.

  • If TRUE, usage accumulates over the entire period the priced Plan is active for the account, and is not reset for pricing band rates at the start of each billing period.

  • If FALSE, usage does not accumulate, and is reset for pricing bands at the start of each billing period.

minimumSpendnumber double

The minimum spend amount per billing cycle for end customer Accounts on a Plan to which the Pricing is applied.

minimumSpendDescriptionstring

Minimum spend description (displayed on the bill line item).

minimumSpendBillInAdvanceboolean

The default value is FALSE.

  • When TRUE, minimum spend is billed at the start of each billing period.

  • When FALSE, minimum spend is billed at the end of each billing period.

(Optional). Overrides the setting at Organization level for minimum spend billing in arrears/in advance.

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

Response

Returns the created Pricing

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
aggregationIdstring

UUID of the Aggregation used to create the Pricing. Use this when creating a Pricing for a segmented aggregation.

compoundAggregationIdstring

UUID of the Compound Aggregation used to create the Pricing.

type'DEBIT' | 'PRODUCT_CREDIT' | 'GLOBAL_CREDIT'

  • DEBIT. Default setting. The amount calculated using the Pricing is added to the bill as a debit.

  • PRODUCT_CREDIT. The amount calculated using the Pricing is added to the bill as a credit (negative amount). To prevent negative billing, the bill will be capped at the total of other line items for the same Product.

  • GLOBAL_CREDIT. The amount calculated using the Pricing is added to the bill as a credit (negative amount). To prevent negative billing, the bill will be capped at the total of other line items for the entire bill, which might include other Products the Account consumes.

segmentobject

Name of the segment for which you are defining a Pricing.

For each segment in a segmented aggregation, make a separate call using aggregationId parameter to update a Pricing.

tiersSpanPlanboolean

The default value is FALSE.

  • If TRUE, usage accumulates over the entire period the priced Plan is active for the account, and is not reset for pricing band rates at the start of each billing period.

  • If FALSE, usage does not accumulate, and is reset for pricing bands at the start of each billing period.

minimumSpendnumber double

The minimum spend amount per billing cycle for end customer Accounts on a Plan to which the Pricing is applied.

minimumSpendDescriptionstring

Minimum spend description (displayed on the bill line item).

minimumSpendBillInAdvanceboolean

The default value is FALSE.

  • When TRUE, minimum spend is billed at the start of each billing period.

  • When FALSE, minimum spend is billed at the end of each billing period.

(Optional). Overrides the setting at Organization level for minimum spend billing in arrears/in advance.

aggregationType'SIMPLE' | 'COMPOUND'
segmentStringstring

Changes

Changed in 2 of the 10 revisions of this API.85

  • 9f9e5f3dbde78See the full diff
    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

    • ▲

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

      response-property-became-optional

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

  • d064a12d0d935See the full diff
    • ○

      added the new optional request property allOf[BasePricingRequestWithPricingBands]/allOf[BasePricingRequest]/allOf[subschema #2]/accountingProductId

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

      added the optional property allOf[BasePricingResponseWithPricingBands]/allOf[BasePricingResponse]/allOf[subschema #3]/accountingProductId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[BasePricingResponse]/allOf[subschema #3]/accountingProductId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #5]/accountingProductId 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