--- title: "Create PlanTemplate" method: POST path: "/organizations/{orgId}/plantemplates" tags: ["PlanTemplate"] --- # Create PlanTemplate `POST /organizations/{orgId}/plantemplates` Create a new PlanTemplate. This endpoint creates a new PlanTemplate within a specific Organization, identified by its unique UUID. The request body should contain the necessary information for the new PlanTemplate. ## Path parameters - `orgId` string, required ## Request body - PlanTemplateRequest - `version` integer — 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](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information. - `productId` string, required — The unique identifier (UUID) of the Product associated with this PlanTemplate. - `name` string, required — Descriptive name for the PlanTemplate. - `currency` string, required — The ISO currency code for the currency used to charge end users - for example USD, GBP, EUR. This defines the *pricing currency* and is inherited by any Plans based on the Plan Template. **Notes:** * You can define a currency at Organization-level or Account-level to be used as the *billing currency*. This can be a different currency to that used for the Plan as the *pricing currency*. * If the billing currency for an Account is different to the pricing currency used by a Plan attached to the Account, you must ensure a *currency conversion rate* is defined for your Organization to convert the pricing currency into the billing currency at billing, otherwise Bills will fail for the Account. * To define any required currency conversion rates, use the `currencyConversions` request body parameter for the [Update OrganizationConfig](https://www.m3ter.com/docs/api#tag/OrganizationConfig/operation/UpdateOrganizationConfig) call. - `standingCharge` number, double, required — The fixed charge *(standing charge)* applied to customer bills. This charge is prorated and must be a non-negative number. - `standingChargeDescription` string — Standing charge description *(displayed on the bill line item)*. - `standingChargeInterval` integer — How often the standing charge is applied. For example, if the bill is issued every three months and `standingChargeInterval` is 2, then the standing charge is applied every six months. - `standingChargeOffset` integer — Defines an offset for when the standing charge is first applied. For example, if the bill is issued every three months and the `standingChargeOfset` is 0, then the charge is applied to the first bill *(at three months)*; if 1, it would be applied to the second bill *(at six months)*, and so on. - `billFrequencyInterval` integer — How often bills are issued. For example, if `billFrequency` is Monthly and `billFrequencyInterval` is 3, bills are issued every three months. - `billFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY' | 'AD_HOC' | 'MIXED', required — Defines how often Bills are generated. * **Daily**. Starting at midnight each day, covering a twenty-four hour period following. * **Weekly**. Starting at midnight on a Monday morning covering the seven-day period following. * **Monthly**. Starting at midnight on the morning of the first day of each month covering the entire calendar month following. * **Annually**. Starting at midnight on the morning of the first day of each year covering the entire calendar year following. * **Ad_Hoc**. Use this setting when a custom billing schedule is used for billing an Account, such as for billing of Prepayment/Commitment fees using a custom billing schedule. - `ordinal` integer — The ranking of the PlanTemplate among your pricing plans. Lower numbers represent more basic plans, while higher numbers represent premium plans. This must be a non-negative integer. **NOTE: DEPRECATED** - do not use. - `code` string — A unique, short code reference for the PlanTemplate. This code should not contain control characters or spaces. - `minimumSpend` number, double — The Product minimum spend amount per billing cycle for end customer Accounts on a pricing Plan based on the PlanTemplate. This must be a non-negative number. - `minimumSpendDescription` string — Minimum spend description *(displayed on the bill line item)*. - `standingChargeBillInAdvance` boolean — A boolean that determines when the standing charge is billed. * TRUE - standing charge is billed at the start of each billing period. * FALSE - standing charge is billed at the end of each billing period. Overrides the setting at Organizational level for standing charge billing in arrears/in advance. - `minimumSpendBillInAdvance` boolean — A boolean that determines when the minimum spend is billed. * TRUE - minimum spend is billed at the start of each billing period. * FALSE - minimum spend is billed at the end of each billing period. Overrides the setting at Organizational level for minimum spend billing in arrears/in advance. ## Response `200` Returns the created PlanTemplate - PlanTemplateResponse - `id` string, required — The UUID of the entity. - `version` integer — 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](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information. - `productId` string — The unique identifier (UUID) of the Product associated with this PlanTemplate. - `name` string — Descriptive name for the PlanTemplate. - `currency` string — The ISO currency code for the pricing currency used by Plans based on the Plan Template to define charge rates for Product consumption - for example USD, GBP, EUR. - `standingCharge` number, double — The fixed charge *(standing charge)* applied to customer bills. This charge is prorated and must be a non-negative number. - `standingChargeDescription` string — Standing charge description *(displayed on the bill line item)*. - `standingChargeInterval` integer — How often the standing charge is applied. For example, if the bill is issued every three months and `standingChargeInterval` is 2, then the standing charge is applied every six months. - `standingChargeOffset` integer — Defines an offset for when the standing charge is first applied. For example, if the bill is issued every three months and the `standingChargeOfset` is 0, then the charge is applied to the first bill *(at three months)*; if 1, it would be applied to the second bill *(at six months)*, and so on. - `billFrequencyInterval` integer — How often bills are issued. For example, if `billFrequency` is Monthly and `billFrequencyInterval` is 3, bills are issued every three months. - `billFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY' | 'AD_HOC' | 'MIXED' — Defines how often Bills are generated. * **Daily**. Starting at midnight each day, covering a twenty-four hour period following. * **Weekly**. Starting at midnight on a Monday morning covering the seven-day period following. * **Monthly**. Starting at midnight on the morning of the first day of each month covering the entire calendar month following. * **Annually**. Starting at midnight on the morning of the first day of each year covering the entire calendar year following. * **Ad_Hoc**. Use this setting when a custom billing schedule is used for billing an Account, such as for billing of Prepayment/Commitment fees using a custom billing schedule. - `ordinal` integer — The ranking of the PlanTemplate among your pricing plans. Lower numbers represent more basic plans, while higher numbers represent premium plans. This must be a non-negative integer. **NOTE:** **DEPRECATED** - no longer used. - `code` string — A unique, short code reference for the PlanTemplate. This code should not contain control characters or spaces. - `minimumSpend` number, double — The Product minimum spend amount per billing cycle for end customer Accounts on a pricing Plan based on the PlanTemplate. This must be a non-negative number. - `minimumSpendDescription` string — Minimum spend description *(displayed on the bill line item)*. - `standingChargeBillInAdvance` boolean — A boolean that determines when the standing charge is billed. * TRUE - standing charge is billed at the start of each billing period. * FALSE - standing charge is billed at the end of each billing period. Overrides the setting at Organizational level for standing charge billing in arrears/in advance. - `minimumSpendBillInAdvance` boolean — A boolean that determines when the minimum spend is billed. * TRUE - minimum spend is billed at the start of each billing period. * FALSE - minimum spend is billed at the end of each billing period. Overrides the setting at Organizational level for minimum spend billing in arrears/in advance. - `dtCreated` string, date-time — The date and time *(in ISO-8601 format)* when the PlanTemplate was created. - `dtLastModified` string, date-time — The date and time *(in ISO-8601 format)* when the PlanTemplate was last modified. - `createdBy` string — The unique identifier (UUID) of the user who created this PlanTemplate. - `lastModifiedBy` string — The unique identifier (UUID) of the user who last modified this PlanTemplate. ## Other responses - `4XX` — Error message - `5XX` — Error message --- [API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)