Documentation

Fields

• postPlansRequestBodyActive :: Maybe Bool

  active: Whether the plan is currently available for new subscriptions. Defaults to `true`.

• postPlansRequestBodyAggregateUsage :: Maybe PostPlansRequestBodyAggregateUsage'

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

• postPlansRequestBodyAmount :: Maybe Integer

  amount: A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.

• postPlansRequestBodyAmountDecimal :: Maybe String

  amount_decimal: Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.

• postPlansRequestBodyBillingScheme :: Maybe PostPlansRequestBodyBillingScheme'

  billing_scheme: 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.

• postPlansRequestBodyCurrency :: String

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• postPlansRequestBodyExpand :: Maybe ([] String)

  expand: Specifies which fields in the response should be expanded.

• postPlansRequestBodyId :: Maybe String

  id: 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.

  Constraints:

  • Maximum length of 5000
• postPlansRequestBodyInterval :: PostPlansRequestBodyInterval'

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

• postPlansRequestBodyIntervalCount :: Maybe Integer

  interval_count: 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).

• postPlansRequestBodyMetadata :: Maybe PostPlansRequestBodyMetadata'

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

• postPlansRequestBodyNickname :: Maybe String

  nickname: A brief description of the plan, hidden from customers.

  Constraints:

  • Maximum length of 5000
• postPlansRequestBodyProduct :: Maybe PostPlansRequestBodyProduct'Variants

  product

• postPlansRequestBodyTiers :: Maybe ([] PostPlansRequestBodyTiers')

  tiers: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.

• postPlansRequestBodyTiersMode :: Maybe PostPlansRequestBodyTiersMode'

  tiers_mode: 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.

  Constraints:

  • Maximum length of 5000
• postPlansRequestBodyTransformUsage :: Maybe PostPlansRequestBodyTransformUsage'

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

• postPlansRequestBodyTrialPeriodDays :: Maybe Integer

  trial_period_days: Default number of trial days when subscribing a customer to this plan using `trial_from_plan=true`.

• postPlansRequestBodyUsageType :: Maybe PostPlansRequestBodyUsageType'

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

Fields

• postPlansRequestBodyProduct'OneOf2Active :: Maybe Bool

  active

• postPlansRequestBodyProduct'OneOf2Id :: Maybe String

  id

  Constraints:

  • Maximum length of 5000
• postPlansRequestBodyProduct'OneOf2Metadata :: Maybe PostPlansRequestBodyProduct'OneOf2Metadata'

  metadata

• postPlansRequestBodyProduct'OneOf2Name :: String

  name

  Constraints:

  • Maximum length of 5000
• postPlansRequestBodyProduct'OneOf2StatementDescriptor :: Maybe String

  statement_descriptor

  Constraints:

  • Maximum length of 22
• postPlansRequestBodyProduct'OneOf2UnitLabel :: Maybe String

  unit_label

  Constraints:

  • Maximum length of 12

Fields

• postPlansRequestBodyTiers'FlatAmount :: Maybe Integer

  flat_amount

• postPlansRequestBodyTiers'FlatAmountDecimal :: Maybe String

  flat_amount_decimal

• postPlansRequestBodyTiers'UnitAmount :: Maybe Integer

  unit_amount

• postPlansRequestBodyTiers'UnitAmountDecimal :: Maybe String

  unit_amount_decimal

• postPlansRequestBodyTiers'UpTo :: PostPlansRequestBodyTiers'UpTo'Variants

  up_to

Fields

• postPlansRequestBodyTransformUsage'DivideBy :: Integer

  divide_by

• postPlansRequestBodyTransformUsage'Round :: PostPlansRequestBodyTransformUsage'Round'

  round

  Constraints:

  • Maximum length of 5000