Create PlanGroup - m3ter Documentation

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

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

Body

application/json

name

string

required

The name of the PlanGroup.

Required string length: 1 - 200

currency

string

required

Currency code for the PlanGroup (For example, USD).

Required string length: 3

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.

customFields

object

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.

code

string

The short code representing the PlanGroup.

Maximum string length: 80

Pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$

minimumSpend

number<double>

The minimum spend amount for the PlanGroup.

Required range: x >= 0

minimumSpendDescription

string

Description of the minimum spend, displayed on the bill line item.

Maximum string length: 200

standingCharge

number<double>

Standing charge amount for the PlanGroup.

Required range: x >= 0

standingChargeDescription

string

Description of the standing charge, displayed on the bill line item.

Maximum string length: 200

standingChargeBillInAdvance

boolean

A boolean flag that determines when the standing charge is billed. This flag overrides the setting at Organizational level for standing charge billing in arrears/in advance.

TRUE - standing charge is billed at the start of each billing period.
FALSE - standing charge is billed at the end of each billing period.

minimumSpendBillInAdvance

boolean

A boolean flag that determines when the minimum spend is billed. This flag overrides the setting at Organizational level for minimum spend billing in arrears/in advance.

TRUE - minimum spend is billed at the start of each billing period.
FALSE - minimum spend is billed at the end of each billing period.

accountId

string

Optional. This PlanGroup is created as bespoke for the associated Account with this Account ID.

Required string length: 36

minimumSpendAccountingProductId

string

Optional. Product ID to attribute the PlanGroup's minimum spend for accounting purposes.

standingChargeAccountingProductId

string

Optional. Product ID to attribute the PlanGroup's standing charge for accounting purposes.

Response

Returns the created PlanGroup

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.

customFields

object

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.

name

string

The name of the PlanGroup.

code

string

The short code representing the PlanGroup.

standingCharge

number<double>

Standing charge amount for the PlanGroup.

standingChargeDescription

string

Description of the standing charge, displayed on the bill line item.

minimumSpend

number<double>

The minimum spend amount for the PlanGroup.

minimumSpendDescription

string

Description of the minimum spend, displayed on the bill line item.

currency

string

Currency code for the PlanGroup (For example, USD).

standingChargeBillInAdvance

boolean

A boolean flag that determines when the standing charge is billed. This flag overrides the setting at Organizational level for standing charge billing in arrears/in advance.

TRUE - standing charge is billed at the start of each billing period.
FALSE - standing charge is billed at the end of each billing period.

minimumSpendBillInAdvance

boolean

A boolean flag that determines when the minimum spend is billed. This flag overrides the setting at Organizational level for minimum spend billing in arrears/in advance.

TRUE - minimum spend is billed at the start of each billing period.
FALSE - minimum spend is billed at the end of each billing period.

accountId

string

Optional. This PlanGroup was created as bespoke for the associated Account with this Account ID.

minimumSpendAccountingProductId

string

Optional. Product ID to attribute the PlanGroup's minimum spend for accounting purposes.

standingChargeAccountingProductId

string

Optional. Product ID to attribute the PlanGroup's standing charge for accounting purposes.

dtCreated

string<date-time>

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

dtLastModified

string<date-time>

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

createdBy

string

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

lastModifiedBy

string

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