Sign in
Plan

Create Plan

Create a new Plan.

post/organizations/{orgId}/plans

Path parameters

orgIdstring required

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

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.

planTemplateIdstring required

UUID of the PlanTemplate the Plan belongs to.

namestring required

Descriptive name for the Plan.

codestring required

Unique short code reference for the Plan.

standingChargenumber double

The standing charge applied to bills for end customers. This is prorated.

(Optional). Overrides PlanTemplate value.

standingChargeDescriptionstring

Standing charge description (displayed on the bill line item).

ordinalinteger

Assigns a rank or position to the Plan in your order of pricing plans - lower numbers represent more basic pricing plans; higher numbers represent more premium pricing plans.

(Optional). Overrides PlanTemplate value.

NOTE: DEPRECATED - do not use.

bespokeboolean

TRUE/FALSE flag indicating whether the plan is a custom/bespoke Plan for a particular Account:

  • When creating a Plan, use the accountId request parameter to specify the Account for which the Plan will be custom/bespoke.
  • A custom/bespoke Plan can only be attached to the specified Account.
minimumSpendnumber double

The product minimum spend amount per billing cycle for end customer Accounts on a priced Plan.

(Optional). Overrides PlanTemplate value.

minimumSpendDescriptionstring

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

standingChargeBillInAdvanceboolean

When TRUE, standing charge is billed at the start of each billing period.

When FALSE, standing charge is billed at the end of each billing period.

(Optional). Overrides the setting at PlanTemplate level for standing charge billing in arrears/in advance.

minimumSpendBillInAdvanceboolean

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 PlanTemplate level for minimum spend billing in arrears/in advance.

minimumSpendAccountingProductIdstring

Optional Product ID this plan's minimum spend should be attributed to for accounting purposes

standingChargeAccountingProductIdstring

Optional Product ID this plan's standing charge should be attributed to for accounting purposes

accountIdstring

(Optional). Used to specify an Account for which the Plan will be a custom/bespoke Plan:

  • Use when first creating a Plan.
  • A custom/bespoke Plan can only be attached to the specified Account.
  • Once created, a custom/bespoke Plan cannot be updated to be made a custom/bespoke Plan for a different Account.

Response

Returns the created Plan

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.

planTemplateIdstring

UUID of the PlanTemplate the Plan belongs to.

productIdstring

UUID of the Product the Plan belongs to.

namestring

Descriptive name for the Plan.

codestring

Unique short code reference for the Plan.

standingChargenumber double

The standing charge applied to bills for end customers. This is prorated.

(Optional). Overrides PlanTemplate value.

standingChargeDescriptionstring

Standing charge description (displayed on the bill line item).

ordinalinteger

Assigns a rank or position to the Plan in your order of pricing plans - lower numbers represent more basic pricing plans; higher numbers represent more premium pricing plans.

(Optional). Overrides PlanTemplate value.

NOTE: DEPRECATED - no longer used.

bespokeboolean

TRUE/FALSE flag indicating whether the plan is custom/bespoke for a particular Account.

minimumSpendnumber double

The product minimum spend amount per billing cycle for end customer Accounts on a priced Plan.

(Optional). Overrides PlanTemplate value.

minimumSpendDescriptionstring

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

standingChargeBillInAdvanceboolean

When TRUE, standing charge is billed at the start of each billing period.

When FALSE, standing charge is billed at the end of each billing period.

(Optional). Overrides the setting at PlanTemplate level for standing charge billing in arrears/in advance.

minimumSpendBillInAdvanceboolean

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 PlanTemplate level for minimum spend billing in arrears/in advance.

minimumSpendAccountingProductIdstring

Optional Product ID this plan's minimum spend should be attributed to for accounting purposes

standingChargeAccountingProductIdstring

Optional Product ID this plan's standing charge should be attributed to for accounting purposes

accountIdstring

(Optional). The Account ID for which this plan was created as custom/bespoke. A custom/bespoke Plan can only be attached to the specified Account.

dtCreatedstring date-time

The DateTime (in ISO-8601 format) when the plan was created.

dtLastModifiedstring date-time

The DateTime (in ISO-8601 format) when the plan was last modified.

createdBystring

The id of the user who created this plan.

lastModifiedBystring

The id of the user who last modified this plan.

Changes

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

  • 9f9e5f3dbde72See the full diff
    • ▲

      the response property allOf[AbstractResponseWithCustomFields]/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

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

  • d064a12d0d93114See the full diff
    • ▲

      the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property type/format changed from / to object/

      request-property-type-changed

    • ●

      removed subschema #1 subschema #2 from the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property allOf list

      request-property-all-of-removed

    • ○

      added the new optional request property allOf[subschema #3]/minimumSpendAccountingProductId

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #3]/standingChargeAccountingProductId

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ○

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