# Plans > For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt). Specifies the price with billing frequency for a subscription. Create separate plans for varied price or billing frequency. For example, if you need to charge $10 per month for a group of customers and $100 per year for another group of customers, then create separate plans for each. ## Sample Plan ```json { "addon_applicability": "all", "charge_model": "flat_fee", "currency_code": "USD", "enabled_in_hosted_pages": true, "enabled_in_portal": true, "free_quantity": 0, "giftable": false, "id": "silver", "invoice_name": "sample plan", "is_shippable": false, "name": "Silver", "object": "plan", "period": 1, "period_unit": "month", "price": 5000, "pricing_model": "flat_fee", "resource_version": 1517505797000, "show_description_in_invoices": false, "show_description_in_quotes": false, "status": "active", "taxable": true, "updated_at": 1517505797 } ``` ## Plans attributes ## Input Parameters - `id` (required, string, max chars=100) A unique ID for your system to identify the plan. - `name` (required, string, max chars=100) The display name used in web interface for identifying the plan. - `invoice_name` (optional, string, max chars=100) Display name used in invoice. If it is not configured then name is used in invoice. - `description` (optional, string, max chars=2000) Description about the plan to show in the hosted pages & customer portal. **Note:** If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected. - `price` (optional, in cents, min=0) The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started) . - `currency_code` (required, string, max chars=3) The currency code (ISO 4217 format) of the plan - `period` (required, integer, default=1, min=1) Defines billing frequency. Example: to bill customer every 3 months, provide "3" here. - `period_unit` (required, enumerated string, default=month) Defines billing frequency in association with billing period. Possible enum values: - `day` Charge based on day(s) - `week` Charge based on week(s) - `month` Charge based on month(s) - `year` Charge based on year(s) - `trial_period` (optional, integer, min=1) The free time window for your customer to try your product - `trial_period_unit` (optional, enumerated string) Time unit for the trial period. Possible enum values: - `day` In days - `month` In months - `trial_end_action` (optional, enumerated string) Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action) . Possible enum values: - `site_default` The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. - `activate_subscription` The subscription activates and charges are raised for non-metered items. - `cancel_subscription` The subscription cancels. - `pricing_model` (required, enumerated string, default=flat_fee) Defines how the recurring charges for the subscription is calculated. Possible enum values: - `flat_fee` A fixed price that is not quantity-based. - `per_unit` A fixed price per unit quantity. - `tiered` There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. - `volume` The per unit price is based on the tier that the total quantity falls in. - `stairstep` A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in. - `free_quantity` (required, integer, default=0, min=0) Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription. - `setup_cost` (optional, in cents, min=1) One-time setup fee charged as part of the first invoice. - `status` (required, enumerated string, default=active) The plan state Possible enum values: - `active` New subscriptions can be created with the plan. - `archived` No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. - `deleted` Indicates the plan has been deleted. - `archived_at` (optional, timestamp(UTC) in seconds) Time at which the plan was moved to archived status. - `billing_cycles` (optional, integer, min=1) The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically - `redirect_url` (optional, string, max chars=500) The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic - `enabled_in_hosted_pages` (required, boolean, default=true) If true, allow checkout through plan specific hosted page URL for this plan. - `enabled_in_portal` (required, boolean, default=true) If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal. - `addon_applicability` (required, enumerated string, default=all) Indicates if all or only some addons are applicable with the plan. Possible enum values: - `all` All addons are applicable with this plan. - `restricted` Only addons marked as 'applicable\_addons' are applicable with the plan. - `tax_code` (optional, string, max chars=50) The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html) . - `hsn_code` (optional, string, max chars=50) The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html) to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true: - [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.) - The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. - `taxjar_product_code` (optional, string, max chars=50) The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html) . - `avalara_sale_type` (optional, enumerated string) Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Possible enum values: - `wholesale` Transaction is a sale to another company that will resell your product or service to another consumer - `retail` Transaction is a sale to an end user - `consumed` Transaction is for an item that is consumed directly - `vendor_use` Transaction is for an item that is subject to vendor use tax - `avalara_transaction_type` (optional, integer) Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. - `avalara_service_type` (optional, integer) Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. - `sku` (optional, string, max chars=100) The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application. - `accounting_code` (optional, string, max chars=100) This field is to capture the Account code setup in your Accounting system for integration purposes only. - `accounting_category1` (optional, string, max chars=100) Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html ) - [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.` - [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...` - [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) If you've categorized your products in NetSuite under Classes, provide the class name here. Use the following format: `: : ....` For example: `Services : Plan.` - [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here. - `accounting_category2` (optional, string, max chars=100) Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html ) - [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, then provide the second category name and option here. Use the format: `: ....` For example, `Region: South` - [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: `::....` For example: `Location: North America: Canada` - [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) If you've categorized your products in NetSuite under Locations, provide the location name here. Use the following format `: : ....` For example: `NA:US:CA` - [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here. - `accounting_category3` (optional, string, max chars=100) Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html ) - [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) If you've categorized your products in NetSuite under Departments, pass the department name here. Use the following format: `: : ....` For example: `Production: Assembly.` - [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here. - `accounting_category4` (optional, string, max chars=100) Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html ) - [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the "Revenue Recognition Rule Id" for the product from NetSuite. - [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured "Revenue Recognition Templates" for products in Intacct, provide the template ID for the product. - `is_shippable` (optional, boolean, default=false) If enabled, charges for this plan/addon will be added to orders. - `shipping_frequency_period` (optional, integer, min=1) Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here. - `shipping_frequency_period_unit` (optional, enumerated string) Defines the shipping frequency in association with shipping period. Possible enum values: - `year` Ship based on year(s) - `month` Ship based on month(s) - `week` Ship based on week(s) - `day` Ship based on day(s) - `resource_version` (optional, long) Version number of this resource. The `resource_version` is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28. - `updated_at` (optional, timestamp(UTC) in seconds) Timestamp indicating when this plan was last updated. This attribute will be present only if the resource has been updated after 2016-11-09. - `giftable` (required, boolean, default=false) Specifies if the plan should be gifted or not. - `claim_url` (optional, string, max chars=500) The url to redirect on successful claim. Eg: https://yoursite.com/claim\_success.html?plan=basic - `free_quantity_in_decimal` (optional, string, max chars=33) The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `price_in_decimal` (optional, string, max chars=39) The price of the plan when the `pricing_model` is `flat_fee`. When the pricing model is `per_unit` , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `channel` (optional, enumerated string) The subscription channel this object originated from and is maintained in. Possible enum values: - `web` The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. - `app_store` The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. - `play_store` The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information. - `invoice_notes` (optional, string, max chars=2000) A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes) displayed on the invoice PDF. - `taxable` (optional, boolean, default=true) Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html) have been disabled in Chargebee. However, the value is effective only while Taxes are enabled. - `tax_profile_id` (optional, string, max chars=50) Tax profile of the plan. - `meta_data` (optional, jsonobject) A collection of key-value pairs that provides extra information about the plan. **Note:** There's a character limit of 65,535. [Learn more](/docs/api/v2/pcv-1/advanced-features) . - `show_description_in_invoices` (optional, boolean, default=false) Whether the `[plan.description](/docs/api/v2/pcv-1/plans/plan-object)` should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf). If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices) )after the change are affected; past invoices are not. - `show_description_in_quotes` (optional, boolean, default=false) Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object) should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf). If this Boolean is changed, only quotes created after the change are affected; past quotes are not. - `tiers` (optional, list of tier) List of tiers for this plan(applicable only if it is tiered/volume/stairtstep pricing) - `starting_unit` (required, integer, min=1) The lower limit of a range of units for the tier - `ending_unit` (optional, integer) The upper limit of a range of units for the tier - `price` (required, in cents, default=0, min=0) The per-unit price for the tier when the `pricing_model` is `tiered` or `volume` ; the total cost for the item price when the `pricing_model` is `stairstep`. The value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies) . - `starting_unit_in_decimal` (optional, string, max chars=33) The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. Returned only when the `pricing_model` is `tiered` , `volume` or `stairstep` and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `ending_unit_in_decimal` (optional, string, max chars=33) The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal` of the next higher tier. Returned only when the `pricing_model` is `tiered` , `volume` or `stairstep` and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `price_in_decimal` (optional, string, max chars=39) The decimal representation of the per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. When the `pricing_model` is `stairstep` , it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `tax_providers_fields` (optional, list of tax_providers_field) List of vendor specific tax related information. - `provider_name` (required, string, max chars=50) Name of the tax provider currently we support. - `field_id` (required, string, max chars=50) Field id of the attribute which tax vendor has provided while getting onboarded with us. - `field_value` (required, string, max chars=50) The value of the corresponding tax field. - `applicable_addons` (optional, list of applicable_addon) List of addons applicable with this plan. - `id` (required, string, max chars=100) Identifier of the addon appplicable to the plan. - `attached_addons` (optional, list of attached_addon) Indicates if the addon is attached with the plan as mandatory or recommended. - `id` (required, string, max chars=100) Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan. - `quantity` (required, integer, min=1) Quantity of the addon. Applicable for addons with `pricing_model` other than `flat_fee` . - `billing_cycles` (optional, integer, min=1) The number of billing cycles this addon will be attached to the plan. - `type` (required, enumerated string) Specifies attachment type of the addon to the plan Possible enum values: - `recommended` Addon will be charged with this plan unless specifically removed. - `mandatory` Addon will be always charged with this plan. - `quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled. - `event_based_addons` (optional, list of event_based_addon) List of addons that will be charged on occurrence of specific event on subscribing to the plan. - `id` (required, string, max chars=100) Identifier of the addon. Multiple addons can be passed. - `quantity` (required, integer, min=1) Quantity of the addon. Applicable for addons with `pricing_model` other than `flat_fee` . - `on_event` (required, enumerated string) Event on which the addon will be charged Possible enum values: - `subscription_creation` Addon will be charged on subscription creation. - `subscription_trial_start` Addon will be charged when the trial period starts. - `plan_activation` Addon will be charged on plan activation. - `subscription_activation` Addon will be charged on subscription activation. - `contract_termination` Addon will be charged on contract termination. - `charge_once` (required, boolean, default=true) If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons. - `quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies) is enabled.