StripeAPI.Operations.PostPlans

POST /v1/plans

<p>You can now model subscriptions more flexibly using the <a href="#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p>

Defines the object schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostPlansRequestBody with all required fields.

Defines the enum schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.aggregate_usage in the specification.

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`.

Defines the enum schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_scheme in the specification.

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.

Defines the enum schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.interval in the specification.

Specifies billing frequency. Either `day`, `week`, `month` or `year`.

Defines the oneOf schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

Set of key-value pairs 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`.

Defines the object schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.product.anyOf in the specification.

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.

Create a new PostPlansRequestBodyProduct'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.product.anyOf in the specification.

Defines the object schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tiers.items in the specification.

Create a new PostPlansRequestBodyTiers' with all required fields.

Defines the oneOf schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tiers.items.properties.up_to.anyOf in the specification.

Defines the enum schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tiers_mode in the specification.

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.

Defines the object schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transform_usage in the specification.

Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.

Create a new PostPlansRequestBodyTransformUsage' with all required fields.

Defines the enum schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transform_usage.properties.round in the specification.

Defines the enum schema located at paths./v1/plans.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.usage_type in the specification.

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`.

Represents a response of the operation postPlans.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostPlansResponseError is used.