Create Plan
Create a new Plan.
Path parameters
UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.
Request body
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.
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.
UUID of the PlanTemplate the Plan belongs to.
Descriptive name for the Plan.
Unique short code reference for the Plan.
The standing charge applied to bills for end customers. This is prorated.
(Optional). Overrides PlanTemplate value.
Standing charge description (displayed on the bill line item).
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.
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.
The product minimum spend amount per billing cycle for end customer Accounts on a priced Plan.
(Optional). Overrides PlanTemplate value.
Minimum spend description (displayed on the bill line item).
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.
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.
Optional Product ID this plan's minimum spend should be attributed to for accounting purposes
Optional Product ID this plan's standing charge should be attributed to for accounting purposes
(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
The UUID of the entity.
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.
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.
UUID of the PlanTemplate the Plan belongs to.
UUID of the Product the Plan belongs to.
Descriptive name for the Plan.
Unique short code reference for the Plan.
The standing charge applied to bills for end customers. This is prorated.
(Optional). Overrides PlanTemplate value.
Standing charge description (displayed on the bill line item).
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.
TRUE/FALSE flag indicating whether the plan is custom/bespoke for a particular Account.
The product minimum spend amount per billing cycle for end customer Accounts on a priced Plan.
(Optional). Overrides PlanTemplate value.
Minimum spend description (displayed on the bill line item).
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.
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.
Optional Product ID this plan's minimum spend should be attributed to for accounting purposes
Optional Product ID this plan's standing charge should be attributed to for accounting purposes
(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.
The DateTime (in ISO-8601 format) when the plan was created.
The DateTime (in ISO-8601 format) when the plan was last modified.
The id of the user who created this plan.
The id of the user who last modified this plan.