StripeAPI.Types.Recurring

Contains the types generated from the schema Recurring

Documentation

data Recurring

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

Constructors

Recurring

Fields

• recurringAggregateUsage :: Maybe RecurringAggregateUsage'

  aggregate_usage: Specifies a usage aggregation strategy for prices 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`.

• recurringInterval :: RecurringInterval'

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

• recurringIntervalCount :: 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.

• recurringUsageType :: RecurringUsageType'

  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 Recurring

Defined in StripeAPI.Types.Recurring

Methods

(==) :: Recurring -> Recurring -> Bool

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

Show Recurring

Defined in StripeAPI.Types.Recurring

Methods

showsPrec :: Int -> Recurring -> ShowS

show :: Recurring -> String

showList :: [Recurring] -> ShowS

ToJSON Recurring

Defined in StripeAPI.Types.Recurring

Methods

toJSON :: Recurring -> Value

toEncoding :: Recurring -> Encoding

toJSONList :: [Recurring] -> Value

toEncodingList :: [Recurring] -> Encoding

FromJSON Recurring

Defined in StripeAPI.Types.Recurring

Methods

parseJSON :: Value -> Parser Recurring

parseJSONList :: Value -> Parser [Recurring]

mkRecurring

Arguments

:: RecurringInterval'

recurringInterval

-> Int

recurringIntervalCount

-> RecurringUsageType'

recurringUsageType

-> Recurring

Create a new Recurring with all required fields.

data RecurringAggregateUsage'

Defines the enum schema located at components.schemas.recurring.properties.aggregate_usage in the specification.

Specifies a usage aggregation strategy for prices 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

RecurringAggregateUsage'Other Value

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

RecurringAggregateUsage'Typed Text

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

RecurringAggregateUsage'EnumLastDuringPeriod

Represents the JSON value "last_during_period"

RecurringAggregateUsage'EnumLastEver

Represents the JSON value "last_ever"

RecurringAggregateUsage'EnumMax

Represents the JSON value "max"

RecurringAggregateUsage'EnumSum

Represents the JSON value "sum"

Instances

Eq RecurringAggregateUsage'

Defined in StripeAPI.Types.Recurring

Methods

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

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

Show RecurringAggregateUsage'

Defined in StripeAPI.Types.Recurring

Methods

showsPrec :: Int -> RecurringAggregateUsage' -> ShowS

show :: RecurringAggregateUsage' -> String

showList :: [RecurringAggregateUsage'] -> ShowS

ToJSON RecurringAggregateUsage'

Defined in StripeAPI.Types.Recurring

Methods

toJSON :: RecurringAggregateUsage' -> Value

toEncoding :: RecurringAggregateUsage' -> Encoding

toJSONList :: [RecurringAggregateUsage'] -> Value

toEncodingList :: [RecurringAggregateUsage'] -> Encoding

FromJSON RecurringAggregateUsage'

Defined in StripeAPI.Types.Recurring

Methods

parseJSON :: Value -> Parser RecurringAggregateUsage'

parseJSONList :: Value -> Parser [RecurringAggregateUsage']

data RecurringInterval'

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

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

Constructors

RecurringInterval'Other Value

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

RecurringInterval'Typed Text

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

RecurringInterval'EnumDay

Represents the JSON value "day"

RecurringInterval'EnumMonth

Represents the JSON value "month"

RecurringInterval'EnumWeek

Represents the JSON value "week"

RecurringInterval'EnumYear

Represents the JSON value "year"

Instances

Eq RecurringInterval'

Defined in StripeAPI.Types.Recurring

Methods

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

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

Show RecurringInterval'

Defined in StripeAPI.Types.Recurring

Methods

showsPrec :: Int -> RecurringInterval' -> ShowS

show :: RecurringInterval' -> String

showList :: [RecurringInterval'] -> ShowS

ToJSON RecurringInterval'

Defined in StripeAPI.Types.Recurring

Methods

toJSON :: RecurringInterval' -> Value

toEncoding :: RecurringInterval' -> Encoding

toJSONList :: [RecurringInterval'] -> Value

toEncodingList :: [RecurringInterval'] -> Encoding

FromJSON RecurringInterval'

Defined in StripeAPI.Types.Recurring

Methods

parseJSON :: Value -> Parser RecurringInterval'

parseJSONList :: Value -> Parser [RecurringInterval']

data RecurringUsageType'

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

RecurringUsageType'Other Value

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

RecurringUsageType'Typed Text

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

RecurringUsageType'EnumLicensed

Represents the JSON value "licensed"

RecurringUsageType'EnumMetered

Represents the JSON value "metered"

Instances

Eq RecurringUsageType'

Defined in StripeAPI.Types.Recurring

Methods

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

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

Show RecurringUsageType'

Defined in StripeAPI.Types.Recurring

Methods

showsPrec :: Int -> RecurringUsageType' -> ShowS

show :: RecurringUsageType' -> String

showList :: [RecurringUsageType'] -> ShowS

ToJSON RecurringUsageType'

Defined in StripeAPI.Types.Recurring

Methods

toJSON :: RecurringUsageType' -> Value

toEncoding :: RecurringUsageType' -> Encoding

toJSONList :: [RecurringUsageType'] -> Value

toEncodingList :: [RecurringUsageType'] -> Encoding

FromJSON RecurringUsageType'

Defined in StripeAPI.Types.Recurring

Methods

parseJSON :: Value -> Parser RecurringUsageType'

parseJSONList :: Value -> Parser [RecurringUsageType']