# PostPlans From **Stripe API**. `POST /v1/plans`

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

## Request body - Required: true ### `application/x-www-form-urlencoded` - Type: `object` ```json {"additionalProperties":false,"properties":{"active":{"description":"Whether the plan is currently available for new subscriptions. Defaults to `true`.","type":"boolean"},"aggregate_usage":{"description":"Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.","enum":["last_during_period","last_ever","max","sum"],"type":"string"},"amount":{"description":"A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.","type":"integer"},"amount_decimal":{"description":"Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.","format":"decimal","type":"string"},"billing_scheme":{"description":"Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.","enum":["per_unit","tiered"],"type":"string"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"id":{"description":"An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.","maxLength":5000,"type":"string"},"interval":{"description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"],"type":"string"},"interval_count":{"description":"The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).","type":"integer"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}],"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"nickname":{"description":"A brief description of the plan, hidden from customers.","maxLength":5000,"type":"string"},"product":{"anyOf":[{"description":"The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type).","properties":{"active":{"type":"boolean"},"id":{"maxLength":5000,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"maxLength":5000,"type":"string"},"statement_descriptor":{"maxLength":22,"type":"string"},"tax_code":{"maxLength":5000,"type":"string"},"unit_label":{"maxLength":12,"type":"string"}},"required":["name"],"title":"inline_product_params","type":"object"},{"description":"The ID of the product whose pricing the created plan will represent.","maxLength":5000,"type":"string"}]},"tiers":{"description":"Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.","items":{"properties":{"flat_amount":{"type":"integer"},"flat_amount_decimal":{"format":"decimal","type":"string"},"unit_amount":{"type":"integer"},"unit_amount_decimal":{"format":"decimal","type":"string"},"up_to":{"anyOf":[{"enum":["inf"],"maxLength":5000,"type":"string"},{"type":"integer"}]}},"required":["up_to"],"title":"tier","type":"object"},"type":"array"},"tiers_mode":{"description":"Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.","enum":["graduated","volume"],"type":"string"},"transform_usage":{"description":"Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.","properties":{"divide_by":{"type":"integer"},"round":{"enum":["down","up"],"type":"string"}},"required":["divide_by","round"],"title":"transform_usage_param","type":"object"},"trial_period_days":{"description":"Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).","type":"integer"},"usage_type":{"description":"Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.","enum":["licensed","metered"],"type":"string"}},"required":["currency","interval"],"type":"object"} ``` ## Security ### `basicAuth` - Type: `http` - Request header: `Authorization` - Scheme: `basic` Send credentials in the `Authorization` request header using the `Basic` scheme. Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic ### `bearerAuth` - Type: `http` - Request header: `Authorization` - Scheme: `bearer` - Bearer format: `auth-scheme` Send the token in the `Authorization` request header using the `Bearer` scheme. Bearer HTTP authentication. Allowed headers-- Authorization: Bearer ## Responses ### `200` Successful response. ### `application/json` - Type: `object` You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. Plans define the base price, currency, and billing cycle for recurring purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/billing/prices-guide). ```json {"description":"You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/billing/prices-guide).","properties":{"active":{"description":"Whether the plan can be used for new purchases.","type":"boolean"},"aggregate_usage":{"description":"Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.","enum":["last_during_period","last_ever","max","sum"],"nullable":true,"type":"string"},"amount":{"description":"The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.","nullable":true,"type":"integer"},"amount_decimal":{"description":"The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.","format":"decimal","nullable":true,"type":"string"},"billing_scheme":{"description":"Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.","enum":["per_unit","tiered"],"type":"string"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"interval":{"description":"The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.","enum":["day","month","week","year"],"type":"string"},"interval_count":{"description":"The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.","type":"integer"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","nullable":true,"type":"object"},"nickname":{"description":"A brief description of the plan, hidden from customers.","maxLength":5000,"nullable":true,"type":"string"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["plan"],"type":"string"},"product":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/product"},{"$ref":"#/components/schemas/deleted_product"}],"description":"The product whose pricing this plan determines.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/product"},{"$ref":"#/components/schemas/deleted_product"}]}},"tiers":{"description":"Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.","items":{"$ref":"#/components/schemas/plan_tier"},"type":"array"},"tiers_mode":{"description":"Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.","enum":["graduated","volume"],"nullable":true,"type":"string"},"transform_usage":{"anyOf":[{"$ref":"#/components/schemas/transform_usage"}],"description":"Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.","nullable":true},"trial_period_days":{"description":"Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).","nullable":true,"type":"integer"},"usage_type":{"description":"Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.","enum":["licensed","metered"],"type":"string"}},"required":["active","billing_scheme","created","currency","id","interval","interval_count","livemode","object","usage_type"],"title":"Plan","type":"object","x-expandableFields":["product","tiers","transform_usage"],"x-resourceId":"plan"} ``` ### `default` Error response. ### `application/json` - Type: `object` An error response from the Stripe API ```json {"description":"An error response from the Stripe API","properties":{"error":{"$ref":"#/components/schemas/api_errors"}},"required":["error"],"type":"object"} ``` ## Request examples ### cURL ```shell curl --request POST \ --url https://api.stripe.com/v1/plans \ --header 'content-type: application/x-www-form-urlencoded' \ --data '{ "active": true, "aggregate_usage": "string", "amount": 1, "amount_decimal": "string", "billing_scheme": "string", "currency": "string", "expand": [ "string" ], "id": "string", "interval": "string", "interval_count": 1, "metadata": "string", "nickname": "string", "product": "string", "tiers": [ { "flat_amount": 1, "flat_amount_decimal": "string", "unit_amount": 1, "unit_amount_decimal": "string", "up_to": "string" } ], "tiers_mode": "string", "transform_usage": { "divide_by": 1, "round": "string" }, "trial_period_days": 1, "usage_type": "string" }' ```