StripeAPI.Types.Rule

Contains the types generated from the schema Rule

Documentation

data Rule

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

Constructors

Rule

Fields

• ruleAction :: Text

  action: The action taken on the payment.

  Constraints:

  • Maximum length of 5000
• ruleId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• rulePredicate :: Text

  predicate: The predicate to evaluate the payment against.

  Constraints:

  • Maximum length of 5000

Instances

Eq Rule

Defined in StripeAPI.Types.Rule

Methods

(==) :: Rule -> Rule -> Bool

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

Show Rule

Defined in StripeAPI.Types.Rule

Methods

showsPrec :: Int -> Rule -> ShowS

show :: Rule -> String

showList :: [Rule] -> ShowS

ToJSON Rule

Defined in StripeAPI.Types.Rule

Methods

toJSON :: Rule -> Value

toEncoding :: Rule -> Encoding

toJSONList :: [Rule] -> Value

toEncodingList :: [Rule] -> Encoding

FromJSON Rule

Defined in StripeAPI.Types.Rule

Methods

parseJSON :: Value -> Parser Rule

parseJSONList :: Value -> Parser [Rule]

mkRule

Arguments

:: Text

ruleAction

-> Text

ruleId

-> Text

rulePredicate

-> Rule

Create a new Rule with all required fields.