StripeAPI.Operations.PostPlans

Contains the different functions to run the operation postPlans

Documentation

postPlans

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> PostPlansRequestBody

The request body to send

-> m (Either HttpException (Response PostPlansResponse))

Monad containing the result of the operation

POST /v1/plans

<p>You can create plans using the API, or in the Stripe <a href="https://dashboard.stripe.com/subscriptions/products">Dashboard</a>.</p>

postPlansRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostPlansRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/plans

The same as postPlans but returns the raw ByteString

postPlansM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostPlansRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPlansResponse))

POST /v1/plans

Monadic version of postPlans (use with runWithConfiguration)

postPlansRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostPlansRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/plans

Monadic version of postPlansRaw (use with runWithConfiguration)

data PostPlansRequestBody

Defines the data type for the schema postPlansRequestBody

Constructors

PostPlansRequestBody

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 Text

  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 :: Text

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

• postPlansRequestBodyExpand :: Maybe ([] Text)

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

• postPlansRequestBodyId :: Maybe Text

  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 Text

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

Instances

Eq PostPlansRequestBody

Defined in StripeAPI.Operations.PostPlans

Methods

(==) :: PostPlansRequestBody -> PostPlansRequestBody -> Bool

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

Show PostPlansRequestBody

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBody -> ShowS

show :: PostPlansRequestBody -> String

showList :: [PostPlansRequestBody] -> ShowS

ToJSON PostPlansRequestBody

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBody -> Value

toEncoding :: PostPlansRequestBody -> Encoding

toJSONList :: [PostPlansRequestBody] -> Value

toEncodingList :: [PostPlansRequestBody] -> Encoding

FromJSON PostPlansRequestBody

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBody

parseJSONList :: Value -> Parser [PostPlansRequestBody]

data PostPlansRequestBodyAggregateUsage'

Defines the enum schema postPlansRequestBodyAggregate_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`.

Constructors

PostPlansRequestBodyAggregateUsage'EnumOther Value

PostPlansRequestBodyAggregateUsage'EnumTyped Text

PostPlansRequestBodyAggregateUsage'EnumStringLastDuringPeriod

PostPlansRequestBodyAggregateUsage'EnumStringLastEver

PostPlansRequestBodyAggregateUsage'EnumStringMax

PostPlansRequestBodyAggregateUsage'EnumStringSum

Instances

Eq PostPlansRequestBodyAggregateUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyAggregateUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyAggregateUsage' -> ShowS

show :: PostPlansRequestBodyAggregateUsage' -> String

showList :: [PostPlansRequestBodyAggregateUsage'] -> ShowS

ToJSON PostPlansRequestBodyAggregateUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyAggregateUsage' -> Value

toEncoding :: PostPlansRequestBodyAggregateUsage' -> Encoding

toJSONList :: [PostPlansRequestBodyAggregateUsage'] -> Value

toEncodingList :: [PostPlansRequestBodyAggregateUsage'] -> Encoding

FromJSON PostPlansRequestBodyAggregateUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyAggregateUsage'

parseJSONList :: Value -> Parser [PostPlansRequestBodyAggregateUsage']

data PostPlansRequestBodyBillingScheme'

Defines the enum schema postPlansRequestBodyBilling_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.

Constructors

PostPlansRequestBodyBillingScheme'EnumOther Value

PostPlansRequestBodyBillingScheme'EnumTyped Text

PostPlansRequestBodyBillingScheme'EnumStringPerUnit

PostPlansRequestBodyBillingScheme'EnumStringTiered

Instances

Eq PostPlansRequestBodyBillingScheme'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyBillingScheme'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyBillingScheme' -> ShowS

show :: PostPlansRequestBodyBillingScheme' -> String

showList :: [PostPlansRequestBodyBillingScheme'] -> ShowS

ToJSON PostPlansRequestBodyBillingScheme'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyBillingScheme' -> Value

toEncoding :: PostPlansRequestBodyBillingScheme' -> Encoding

toJSONList :: [PostPlansRequestBodyBillingScheme'] -> Value

toEncodingList :: [PostPlansRequestBodyBillingScheme'] -> Encoding

FromJSON PostPlansRequestBodyBillingScheme'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyBillingScheme'

parseJSONList :: Value -> Parser [PostPlansRequestBodyBillingScheme']

data PostPlansRequestBodyInterval'

Defines the enum schema postPlansRequestBodyInterval'

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

Constructors

PostPlansRequestBodyInterval'EnumOther Value

PostPlansRequestBodyInterval'EnumTyped Text

PostPlansRequestBodyInterval'EnumStringDay

PostPlansRequestBodyInterval'EnumStringMonth

PostPlansRequestBodyInterval'EnumStringWeek

PostPlansRequestBodyInterval'EnumStringYear

Instances

Eq PostPlansRequestBodyInterval'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyInterval'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyInterval' -> ShowS

show :: PostPlansRequestBodyInterval' -> String

showList :: [PostPlansRequestBodyInterval'] -> ShowS

ToJSON PostPlansRequestBodyInterval'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyInterval' -> Value

toEncoding :: PostPlansRequestBodyInterval' -> Encoding

toJSONList :: [PostPlansRequestBodyInterval'] -> Value

toEncodingList :: [PostPlansRequestBodyInterval'] -> Encoding

FromJSON PostPlansRequestBodyInterval'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyInterval'

parseJSONList :: Value -> Parser [PostPlansRequestBodyInterval']

data PostPlansRequestBodyMetadata'

Defines the data type for the schema postPlansRequestBodyMetadata'

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

Constructors

PostPlansRequestBodyMetadata'

Instances

Eq PostPlansRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyMetadata' -> ShowS

show :: PostPlansRequestBodyMetadata' -> String

showList :: [PostPlansRequestBodyMetadata'] -> ShowS

ToJSON PostPlansRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyMetadata' -> Value

toEncoding :: PostPlansRequestBodyMetadata' -> Encoding

toJSONList :: [PostPlansRequestBodyMetadata'] -> Value

toEncodingList :: [PostPlansRequestBodyMetadata'] -> Encoding

FromJSON PostPlansRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostPlansRequestBodyMetadata']

data PostPlansRequestBodyProduct'OneOf2

Defines the data type for the schema postPlansRequestBodyProduct'OneOf2

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.

Constructors

PostPlansRequestBodyProduct'OneOf2

Fields

• postPlansRequestBodyProduct'OneOf2Active :: Maybe Bool

  active

• postPlansRequestBodyProduct'OneOf2Id :: Maybe Text

  id

  Constraints:

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

  metadata

• postPlansRequestBodyProduct'OneOf2Name :: Text

  name

  Constraints:

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

  statement_descriptor

  Constraints:

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

  unit_label

  Constraints:

  • Maximum length of 12

Instances

Eq PostPlansRequestBodyProduct'OneOf2

Defined in StripeAPI.Operations.PostPlans

Methods

(==) :: PostPlansRequestBodyProduct'OneOf2 -> PostPlansRequestBodyProduct'OneOf2 -> Bool

(/=) :: PostPlansRequestBodyProduct'OneOf2 -> PostPlansRequestBodyProduct'OneOf2 -> Bool

Show PostPlansRequestBodyProduct'OneOf2

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyProduct'OneOf2 -> ShowS

show :: PostPlansRequestBodyProduct'OneOf2 -> String

showList :: [PostPlansRequestBodyProduct'OneOf2] -> ShowS

ToJSON PostPlansRequestBodyProduct'OneOf2

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyProduct'OneOf2 -> Value

toEncoding :: PostPlansRequestBodyProduct'OneOf2 -> Encoding

toJSONList :: [PostPlansRequestBodyProduct'OneOf2] -> Value

toEncodingList :: [PostPlansRequestBodyProduct'OneOf2] -> Encoding

FromJSON PostPlansRequestBodyProduct'OneOf2

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyProduct'OneOf2

parseJSONList :: Value -> Parser [PostPlansRequestBodyProduct'OneOf2]

data PostPlansRequestBodyProduct'OneOf2Metadata'

Defines the data type for the schema postPlansRequestBodyProduct'OneOf2Metadata'

Constructors

PostPlansRequestBodyProduct'OneOf2Metadata'

Instances

Eq PostPlansRequestBodyProduct'OneOf2Metadata'

Defined in StripeAPI.Operations.PostPlans

Methods

(==) :: PostPlansRequestBodyProduct'OneOf2Metadata' -> PostPlansRequestBodyProduct'OneOf2Metadata' -> Bool

(/=) :: PostPlansRequestBodyProduct'OneOf2Metadata' -> PostPlansRequestBodyProduct'OneOf2Metadata' -> Bool

Show PostPlansRequestBodyProduct'OneOf2Metadata'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyProduct'OneOf2Metadata' -> ShowS

show :: PostPlansRequestBodyProduct'OneOf2Metadata' -> String

showList :: [PostPlansRequestBodyProduct'OneOf2Metadata'] -> ShowS

ToJSON PostPlansRequestBodyProduct'OneOf2Metadata'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyProduct'OneOf2Metadata' -> Value

toEncoding :: PostPlansRequestBodyProduct'OneOf2Metadata' -> Encoding

toJSONList :: [PostPlansRequestBodyProduct'OneOf2Metadata'] -> Value

toEncodingList :: [PostPlansRequestBodyProduct'OneOf2Metadata'] -> Encoding

FromJSON PostPlansRequestBodyProduct'OneOf2Metadata'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyProduct'OneOf2Metadata'

parseJSONList :: Value -> Parser [PostPlansRequestBodyProduct'OneOf2Metadata']

data PostPlansRequestBodyProduct'Variants

Define the one-of schema postPlansRequestBodyProduct'

Constructors

PostPlansRequestBodyProduct'Text Text

PostPlansRequestBodyProduct'PostPlansRequestBodyProduct'OneOf2 PostPlansRequestBodyProduct'OneOf2

Instances

Eq PostPlansRequestBodyProduct'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyProduct'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

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

show :: PostPlansRequestBodyProduct'Variants -> String

showList :: [PostPlansRequestBodyProduct'Variants] -> ShowS

Generic PostPlansRequestBodyProduct'Variants

Defined in StripeAPI.Operations.PostPlans

Associated Types

type Rep PostPlansRequestBodyProduct'Variants :: Type -> Type

Methods

from :: PostPlansRequestBodyProduct'Variants -> Rep PostPlansRequestBodyProduct'Variants x

to :: Rep PostPlansRequestBodyProduct'Variants x -> PostPlansRequestBodyProduct'Variants

ToJSON PostPlansRequestBodyProduct'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyProduct'Variants -> Value

toEncoding :: PostPlansRequestBodyProduct'Variants -> Encoding

toJSONList :: [PostPlansRequestBodyProduct'Variants] -> Value

toEncodingList :: [PostPlansRequestBodyProduct'Variants] -> Encoding

FromJSON PostPlansRequestBodyProduct'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyProduct'Variants

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

type Rep PostPlansRequestBodyProduct'Variants

Defined in StripeAPI.Operations.PostPlans

type Rep PostPlansRequestBodyProduct'Variants = D1 (MetaData "PostPlansRequestBodyProduct'Variants" "StripeAPI.Operations.PostPlans" "stripeapi-0.1.0.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostPlansRequestBodyProduct'Text" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "PostPlansRequestBodyProduct'PostPlansRequestBodyProduct'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostPlansRequestBodyProduct'OneOf2)))

data PostPlansRequestBodyTiers'

Defines the data type for the schema postPlansRequestBodyTiers'

Constructors

PostPlansRequestBodyTiers'

Fields

• postPlansRequestBodyTiers'FlatAmount :: Maybe Integer

  flat_amount

• postPlansRequestBodyTiers'FlatAmountDecimal :: Maybe Text

  flat_amount_decimal

• postPlansRequestBodyTiers'UnitAmount :: Maybe Integer

  unit_amount

• postPlansRequestBodyTiers'UnitAmountDecimal :: Maybe Text

  unit_amount_decimal

• postPlansRequestBodyTiers'UpTo :: PostPlansRequestBodyTiers'UpTo'Variants

  up_to

Instances

Eq PostPlansRequestBodyTiers'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyTiers'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyTiers' -> ShowS

show :: PostPlansRequestBodyTiers' -> String

showList :: [PostPlansRequestBodyTiers'] -> ShowS

ToJSON PostPlansRequestBodyTiers'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyTiers' -> Value

toEncoding :: PostPlansRequestBodyTiers' -> Encoding

toJSONList :: [PostPlansRequestBodyTiers'] -> Value

toEncodingList :: [PostPlansRequestBodyTiers'] -> Encoding

FromJSON PostPlansRequestBodyTiers'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyTiers'

parseJSONList :: Value -> Parser [PostPlansRequestBodyTiers']

data PostPlansRequestBodyTiers'UpTo'OneOf1

Defines the enum schema postPlansRequestBodyTiers'Up_to'OneOf1

Constructors

PostPlansRequestBodyTiers'UpTo'OneOf1EnumOther Value

PostPlansRequestBodyTiers'UpTo'OneOf1EnumTyped Text

PostPlansRequestBodyTiers'UpTo'OneOf1EnumStringInf

Instances

Eq PostPlansRequestBodyTiers'UpTo'OneOf1

Defined in StripeAPI.Operations.PostPlans

Methods

(==) :: PostPlansRequestBodyTiers'UpTo'OneOf1 -> PostPlansRequestBodyTiers'UpTo'OneOf1 -> Bool

(/=) :: PostPlansRequestBodyTiers'UpTo'OneOf1 -> PostPlansRequestBodyTiers'UpTo'OneOf1 -> Bool

Show PostPlansRequestBodyTiers'UpTo'OneOf1

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyTiers'UpTo'OneOf1 -> ShowS

show :: PostPlansRequestBodyTiers'UpTo'OneOf1 -> String

showList :: [PostPlansRequestBodyTiers'UpTo'OneOf1] -> ShowS

ToJSON PostPlansRequestBodyTiers'UpTo'OneOf1

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyTiers'UpTo'OneOf1 -> Value

toEncoding :: PostPlansRequestBodyTiers'UpTo'OneOf1 -> Encoding

toJSONList :: [PostPlansRequestBodyTiers'UpTo'OneOf1] -> Value

toEncodingList :: [PostPlansRequestBodyTiers'UpTo'OneOf1] -> Encoding

FromJSON PostPlansRequestBodyTiers'UpTo'OneOf1

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyTiers'UpTo'OneOf1

parseJSONList :: Value -> Parser [PostPlansRequestBodyTiers'UpTo'OneOf1]

data PostPlansRequestBodyTiers'UpTo'Variants

Define the one-of schema postPlansRequestBodyTiers'Up_to'

Constructors

PostPlansRequestBodyTiers'UpTo'PostPlansRequestBodyTiers'UpTo'OneOf1 PostPlansRequestBodyTiers'UpTo'OneOf1

PostPlansRequestBodyTiers'UpTo'Integer Integer

Instances

Eq PostPlansRequestBodyTiers'UpTo'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

(==) :: PostPlansRequestBodyTiers'UpTo'Variants -> PostPlansRequestBodyTiers'UpTo'Variants -> Bool

(/=) :: PostPlansRequestBodyTiers'UpTo'Variants -> PostPlansRequestBodyTiers'UpTo'Variants -> Bool

Show PostPlansRequestBodyTiers'UpTo'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyTiers'UpTo'Variants -> ShowS

show :: PostPlansRequestBodyTiers'UpTo'Variants -> String

showList :: [PostPlansRequestBodyTiers'UpTo'Variants] -> ShowS

Generic PostPlansRequestBodyTiers'UpTo'Variants

Defined in StripeAPI.Operations.PostPlans

Associated Types

type Rep PostPlansRequestBodyTiers'UpTo'Variants :: Type -> Type

Methods

from :: PostPlansRequestBodyTiers'UpTo'Variants -> Rep PostPlansRequestBodyTiers'UpTo'Variants x

to :: Rep PostPlansRequestBodyTiers'UpTo'Variants x -> PostPlansRequestBodyTiers'UpTo'Variants

ToJSON PostPlansRequestBodyTiers'UpTo'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyTiers'UpTo'Variants -> Value

toEncoding :: PostPlansRequestBodyTiers'UpTo'Variants -> Encoding

toJSONList :: [PostPlansRequestBodyTiers'UpTo'Variants] -> Value

toEncodingList :: [PostPlansRequestBodyTiers'UpTo'Variants] -> Encoding

FromJSON PostPlansRequestBodyTiers'UpTo'Variants

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyTiers'UpTo'Variants

parseJSONList :: Value -> Parser [PostPlansRequestBodyTiers'UpTo'Variants]

type Rep PostPlansRequestBodyTiers'UpTo'Variants

Defined in StripeAPI.Operations.PostPlans

type Rep PostPlansRequestBodyTiers'UpTo'Variants = D1 (MetaData "PostPlansRequestBodyTiers'UpTo'Variants" "StripeAPI.Operations.PostPlans" "stripeapi-0.1.0.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostPlansRequestBodyTiers'UpTo'PostPlansRequestBodyTiers'UpTo'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostPlansRequestBodyTiers'UpTo'OneOf1)) :+: C1 (MetaCons "PostPlansRequestBodyTiers'UpTo'Integer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)))

data PostPlansRequestBodyTiersMode'

Defines the enum schema postPlansRequestBodyTiers_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.

Constructors

PostPlansRequestBodyTiersMode'EnumOther Value

PostPlansRequestBodyTiersMode'EnumTyped Text

PostPlansRequestBodyTiersMode'EnumStringGraduated

PostPlansRequestBodyTiersMode'EnumStringVolume

Instances

Eq PostPlansRequestBodyTiersMode'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyTiersMode'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyTiersMode' -> ShowS

show :: PostPlansRequestBodyTiersMode' -> String

showList :: [PostPlansRequestBodyTiersMode'] -> ShowS

ToJSON PostPlansRequestBodyTiersMode'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyTiersMode' -> Value

toEncoding :: PostPlansRequestBodyTiersMode' -> Encoding

toJSONList :: [PostPlansRequestBodyTiersMode'] -> Value

toEncodingList :: [PostPlansRequestBodyTiersMode'] -> Encoding

FromJSON PostPlansRequestBodyTiersMode'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyTiersMode'

parseJSONList :: Value -> Parser [PostPlansRequestBodyTiersMode']

data PostPlansRequestBodyTransformUsage'

Defines the data type for the schema postPlansRequestBodyTransform_usage'

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

Constructors

PostPlansRequestBodyTransformUsage'

Fields

• postPlansRequestBodyTransformUsage'DivideBy :: Integer

  divide_by

• postPlansRequestBodyTransformUsage'Round :: PostPlansRequestBodyTransformUsage'Round'

  round

  Constraints:

  • Maximum length of 5000

Instances

Eq PostPlansRequestBodyTransformUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyTransformUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyTransformUsage' -> ShowS

show :: PostPlansRequestBodyTransformUsage' -> String

showList :: [PostPlansRequestBodyTransformUsage'] -> ShowS

ToJSON PostPlansRequestBodyTransformUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyTransformUsage' -> Value

toEncoding :: PostPlansRequestBodyTransformUsage' -> Encoding

toJSONList :: [PostPlansRequestBodyTransformUsage'] -> Value

toEncodingList :: [PostPlansRequestBodyTransformUsage'] -> Encoding

FromJSON PostPlansRequestBodyTransformUsage'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyTransformUsage'

parseJSONList :: Value -> Parser [PostPlansRequestBodyTransformUsage']

data PostPlansRequestBodyTransformUsage'Round'

Defines the enum schema postPlansRequestBodyTransform_usage'Round'

Constructors

PostPlansRequestBodyTransformUsage'Round'EnumOther Value

PostPlansRequestBodyTransformUsage'Round'EnumTyped Text

PostPlansRequestBodyTransformUsage'Round'EnumStringDown

PostPlansRequestBodyTransformUsage'Round'EnumStringUp

Instances

Eq PostPlansRequestBodyTransformUsage'Round'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyTransformUsage'Round'

Defined in StripeAPI.Operations.PostPlans

Methods

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

show :: PostPlansRequestBodyTransformUsage'Round' -> String

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

ToJSON PostPlansRequestBodyTransformUsage'Round'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyTransformUsage'Round' -> Value

toEncoding :: PostPlansRequestBodyTransformUsage'Round' -> Encoding

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

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

FromJSON PostPlansRequestBodyTransformUsage'Round'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyTransformUsage'Round'

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

data PostPlansRequestBodyUsageType'

Defines the enum schema postPlansRequestBodyUsage_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`.

Constructors

PostPlansRequestBodyUsageType'EnumOther Value

PostPlansRequestBodyUsageType'EnumTyped Text

PostPlansRequestBodyUsageType'EnumStringLicensed

PostPlansRequestBodyUsageType'EnumStringMetered

Instances

Eq PostPlansRequestBodyUsageType'

Defined in StripeAPI.Operations.PostPlans

Methods

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

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

Show PostPlansRequestBodyUsageType'

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansRequestBodyUsageType' -> ShowS

show :: PostPlansRequestBodyUsageType' -> String

showList :: [PostPlansRequestBodyUsageType'] -> ShowS

ToJSON PostPlansRequestBodyUsageType'

Defined in StripeAPI.Operations.PostPlans

Methods

toJSON :: PostPlansRequestBodyUsageType' -> Value

toEncoding :: PostPlansRequestBodyUsageType' -> Encoding

toJSONList :: [PostPlansRequestBodyUsageType'] -> Value

toEncodingList :: [PostPlansRequestBodyUsageType'] -> Encoding

FromJSON PostPlansRequestBodyUsageType'

Defined in StripeAPI.Operations.PostPlans

Methods

parseJSON :: Value -> Parser PostPlansRequestBodyUsageType'

parseJSONList :: Value -> Parser [PostPlansRequestBodyUsageType']

data PostPlansResponse

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.

Constructors

PostPlansResponseError String

Means either no matching case available or a parse error

PostPlansResponse200 Plan

Successful response.

PostPlansResponseDefault Error

Error response.

Instances

Eq PostPlansResponse

Defined in StripeAPI.Operations.PostPlans

Methods

(==) :: PostPlansResponse -> PostPlansResponse -> Bool

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

Show PostPlansResponse

Defined in StripeAPI.Operations.PostPlans

Methods

showsPrec :: Int -> PostPlansResponse -> ShowS

show :: PostPlansResponse -> String

showList :: [PostPlansResponse] -> ShowS