StripeAPI.Types.Plan

Contains the types generated from the schema Plan

Documentation

data Plan

Defines the object schema located at components.schemas.plan in the specification.

You can now model subscriptions more flexibly using the Prices API. 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 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 and more about products and prices.

Constructors

Plan

Fields

• planActive :: Bool

  active: Whether the plan can be used for new purchases.

• planAggregateUsage :: Maybe PlanAggregateUsage'

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

• planAmount :: Maybe Int

  amount: The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.

• planAmountDecimal :: Maybe Text

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

• planBillingScheme :: PlanBillingScheme'

  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.

• planCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• planCurrency :: Text

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

• planId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• planInterval :: PlanInterval'

  interval: The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

• planIntervalCount :: Int

  interval_count: The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.

• planLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• planMetadata :: Maybe Object

  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.

• planNickname :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• planProduct :: Maybe PlanProduct'Variants

  product: The product whose pricing this plan determines.

• planTiers :: Maybe [PlanTier]

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

• planTiersMode :: Maybe PlanTiersMode'

  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 change as the quantity grows.

• planTransformUsage :: Maybe PlanTransformUsage'

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

• planTrialPeriodDays :: Maybe Int

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

• planUsageType :: PlanUsageType'

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

Instances

Eq Plan

Defined in StripeAPI.Types.Plan

Methods

(==) :: Plan -> Plan -> Bool

(/=) :: Plan -> Plan -> Bool

Show Plan

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> Plan -> ShowS

show :: Plan -> String

showList :: [Plan] -> ShowS

ToJSON Plan

Defined in StripeAPI.Types.Plan

Methods

toJSON :: Plan -> Value

toEncoding :: Plan -> Encoding

toJSONList :: [Plan] -> Value

toEncodingList :: [Plan] -> Encoding

FromJSON Plan

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser Plan

parseJSONList :: Value -> Parser [Plan]

mkPlan

Arguments

:: Bool

planActive

-> PlanBillingScheme'

planBillingScheme

-> Int

planCreated

-> Text

planCurrency

-> Text

planId

-> PlanInterval'

planInterval

-> Int

planIntervalCount

-> Bool

planLivemode

-> PlanUsageType'

planUsageType

-> Plan

Create a new Plan with all required fields.

data PlanAggregateUsage'

Defines the enum schema located at components.schemas.plan.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`.

Constructors

PlanAggregateUsage'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PlanAggregateUsage'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PlanAggregateUsage'EnumLastDuringPeriod

Represents the JSON value "last_during_period"

PlanAggregateUsage'EnumLastEver

Represents the JSON value "last_ever"

PlanAggregateUsage'EnumMax

Represents the JSON value "max"

PlanAggregateUsage'EnumSum

Represents the JSON value "sum"

Instances

Eq PlanAggregateUsage'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanAggregateUsage' -> PlanAggregateUsage' -> Bool

(/=) :: PlanAggregateUsage' -> PlanAggregateUsage' -> Bool

Show PlanAggregateUsage'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanAggregateUsage' -> ShowS

show :: PlanAggregateUsage' -> String

showList :: [PlanAggregateUsage'] -> ShowS

ToJSON PlanAggregateUsage'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanAggregateUsage' -> Value

toEncoding :: PlanAggregateUsage' -> Encoding

toJSONList :: [PlanAggregateUsage'] -> Value

toEncodingList :: [PlanAggregateUsage'] -> Encoding

FromJSON PlanAggregateUsage'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanAggregateUsage'

parseJSONList :: Value -> Parser [PlanAggregateUsage']

data PlanBillingScheme'

Defines the enum schema located at components.schemas.plan.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.

Constructors

PlanBillingScheme'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PlanBillingScheme'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PlanBillingScheme'EnumPerUnit

Represents the JSON value "per_unit"

PlanBillingScheme'EnumTiered

Represents the JSON value "tiered"

Instances

Eq PlanBillingScheme'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanBillingScheme' -> PlanBillingScheme' -> Bool

(/=) :: PlanBillingScheme' -> PlanBillingScheme' -> Bool

Show PlanBillingScheme'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanBillingScheme' -> ShowS

show :: PlanBillingScheme' -> String

showList :: [PlanBillingScheme'] -> ShowS

ToJSON PlanBillingScheme'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanBillingScheme' -> Value

toEncoding :: PlanBillingScheme' -> Encoding

toJSONList :: [PlanBillingScheme'] -> Value

toEncodingList :: [PlanBillingScheme'] -> Encoding

FromJSON PlanBillingScheme'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanBillingScheme'

parseJSONList :: Value -> Parser [PlanBillingScheme']

data PlanInterval'

Defines the enum schema located at components.schemas.plan.properties.interval in the specification.

The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

Constructors

PlanInterval'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PlanInterval'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PlanInterval'EnumDay

Represents the JSON value "day"

PlanInterval'EnumMonth

Represents the JSON value "month"

PlanInterval'EnumWeek

Represents the JSON value "week"

PlanInterval'EnumYear

Represents the JSON value "year"

Instances

Eq PlanInterval'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanInterval' -> PlanInterval' -> Bool

(/=) :: PlanInterval' -> PlanInterval' -> Bool

Show PlanInterval'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanInterval' -> ShowS

show :: PlanInterval' -> String

showList :: [PlanInterval'] -> ShowS

ToJSON PlanInterval'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanInterval' -> Value

toEncoding :: PlanInterval' -> Encoding

toJSONList :: [PlanInterval'] -> Value

toEncodingList :: [PlanInterval'] -> Encoding

FromJSON PlanInterval'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanInterval'

parseJSONList :: Value -> Parser [PlanInterval']

data PlanProduct'Variants

Defines the oneOf schema located at components.schemas.plan.properties.product.anyOf in the specification.

The product whose pricing this plan determines.

Constructors

PlanProduct'Text Text

PlanProduct'Product Product

PlanProduct'DeletedProduct DeletedProduct

Instances

Eq PlanProduct'Variants

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanProduct'Variants -> PlanProduct'Variants -> Bool

(/=) :: PlanProduct'Variants -> PlanProduct'Variants -> Bool

Show PlanProduct'Variants

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanProduct'Variants -> ShowS

show :: PlanProduct'Variants -> String

showList :: [PlanProduct'Variants] -> ShowS

ToJSON PlanProduct'Variants

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanProduct'Variants -> Value

toEncoding :: PlanProduct'Variants -> Encoding

toJSONList :: [PlanProduct'Variants] -> Value

toEncodingList :: [PlanProduct'Variants] -> Encoding

FromJSON PlanProduct'Variants

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanProduct'Variants

parseJSONList :: Value -> Parser [PlanProduct'Variants]

data PlanTiersMode'

Defines the enum schema located at components.schemas.plan.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 change as the quantity grows.

Constructors

PlanTiersMode'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PlanTiersMode'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PlanTiersMode'EnumGraduated

Represents the JSON value "graduated"

PlanTiersMode'EnumVolume

Represents the JSON value "volume"

Instances

Eq PlanTiersMode'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanTiersMode' -> PlanTiersMode' -> Bool

(/=) :: PlanTiersMode' -> PlanTiersMode' -> Bool

Show PlanTiersMode'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanTiersMode' -> ShowS

show :: PlanTiersMode' -> String

showList :: [PlanTiersMode'] -> ShowS

ToJSON PlanTiersMode'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanTiersMode' -> Value

toEncoding :: PlanTiersMode' -> Encoding

toJSONList :: [PlanTiersMode'] -> Value

toEncodingList :: [PlanTiersMode'] -> Encoding

FromJSON PlanTiersMode'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanTiersMode'

parseJSONList :: Value -> Parser [PlanTiersMode']

data PlanTransformUsage'

Defines the object schema located at components.schemas.plan.properties.transform_usage.anyOf in the specification.

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

Constructors

PlanTransformUsage'

Fields

• planTransformUsage'DivideBy :: Maybe Int

  divide_by: Divide usage by this number.

• planTransformUsage'Round :: Maybe PlanTransformUsage'Round'

  round: After division, either round the result `up` or `down`.

Instances

Eq PlanTransformUsage'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanTransformUsage' -> PlanTransformUsage' -> Bool

(/=) :: PlanTransformUsage' -> PlanTransformUsage' -> Bool

Show PlanTransformUsage'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanTransformUsage' -> ShowS

show :: PlanTransformUsage' -> String

showList :: [PlanTransformUsage'] -> ShowS

ToJSON PlanTransformUsage'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanTransformUsage' -> Value

toEncoding :: PlanTransformUsage' -> Encoding

toJSONList :: [PlanTransformUsage'] -> Value

toEncodingList :: [PlanTransformUsage'] -> Encoding

FromJSON PlanTransformUsage'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanTransformUsage'

parseJSONList :: Value -> Parser [PlanTransformUsage']

mkPlanTransformUsage' :: PlanTransformUsage'

Create a new PlanTransformUsage' with all required fields.

data PlanTransformUsage'Round'

Defines the enum schema located at components.schemas.plan.properties.transform_usage.anyOf.properties.round in the specification.

After division, either round the result `up` or `down`.

Constructors

PlanTransformUsage'Round'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PlanTransformUsage'Round'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PlanTransformUsage'Round'EnumDown

Represents the JSON value "down"

PlanTransformUsage'Round'EnumUp

Represents the JSON value "up"

Instances

Eq PlanTransformUsage'Round'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanTransformUsage'Round' -> PlanTransformUsage'Round' -> Bool

(/=) :: PlanTransformUsage'Round' -> PlanTransformUsage'Round' -> Bool

Show PlanTransformUsage'Round'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanTransformUsage'Round' -> ShowS

show :: PlanTransformUsage'Round' -> String

showList :: [PlanTransformUsage'Round'] -> ShowS

ToJSON PlanTransformUsage'Round'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanTransformUsage'Round' -> Value

toEncoding :: PlanTransformUsage'Round' -> Encoding

toJSONList :: [PlanTransformUsage'Round'] -> Value

toEncodingList :: [PlanTransformUsage'Round'] -> Encoding

FromJSON PlanTransformUsage'Round'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanTransformUsage'Round'

parseJSONList :: Value -> Parser [PlanTransformUsage'Round']

data PlanUsageType'

Defines the enum schema located at components.schemas.plan.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`.

Constructors

PlanUsageType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PlanUsageType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PlanUsageType'EnumLicensed

Represents the JSON value "licensed"

PlanUsageType'EnumMetered

Represents the JSON value "metered"

Instances

Eq PlanUsageType'

Defined in StripeAPI.Types.Plan

Methods

(==) :: PlanUsageType' -> PlanUsageType' -> Bool

(/=) :: PlanUsageType' -> PlanUsageType' -> Bool

Show PlanUsageType'

Defined in StripeAPI.Types.Plan

Methods

showsPrec :: Int -> PlanUsageType' -> ShowS

show :: PlanUsageType' -> String

showList :: [PlanUsageType'] -> ShowS

ToJSON PlanUsageType'

Defined in StripeAPI.Types.Plan

Methods

toJSON :: PlanUsageType' -> Value

toEncoding :: PlanUsageType' -> Encoding

toJSONList :: [PlanUsageType'] -> Value

toEncodingList :: [PlanUsageType'] -> Encoding

FromJSON PlanUsageType'

Defined in StripeAPI.Types.Plan

Methods

parseJSON :: Value -> Parser PlanUsageType'

parseJSONList :: Value -> Parser [PlanUsageType']