StripeAPI.Types.Capability

Contains the types generated from the schema Capability

Documentation

data Capability

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

This is an object representing a capability for a Stripe account.

Related guide: Account capabilities.

Constructors

Capability

Fields

• capabilityAccount :: CapabilityAccount'Variants

  account: The account for which the capability enables functionality.

• capabilityId :: Text

  id: The identifier for the capability.

  Constraints:

  • Maximum length of 5000
• capabilityRequested :: Bool

  requested: Whether the capability has been requested.

• capabilityRequestedAt :: Maybe Int

  requested_at: Time at which the capability was requested. Measured in seconds since the Unix epoch.

• capabilityRequirements :: Maybe AccountCapabilityRequirements

  requirements:

• capabilityStatus :: CapabilityStatus'

  status: The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`.

Instances

Eq Capability

Defined in StripeAPI.Types.Capability

Methods

(==) :: Capability -> Capability -> Bool

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

Show Capability

Defined in StripeAPI.Types.Capability

Methods

showsPrec :: Int -> Capability -> ShowS

show :: Capability -> String

showList :: [Capability] -> ShowS

ToJSON Capability

Defined in StripeAPI.Types.Capability

Methods

toJSON :: Capability -> Value

toEncoding :: Capability -> Encoding

toJSONList :: [Capability] -> Value

toEncodingList :: [Capability] -> Encoding

FromJSON Capability

Defined in StripeAPI.Types.Capability

Methods

parseJSON :: Value -> Parser Capability

parseJSONList :: Value -> Parser [Capability]

mkCapability

Arguments

:: CapabilityAccount'Variants

capabilityAccount

-> Text

capabilityId

-> Bool

capabilityRequested

-> CapabilityStatus'

capabilityStatus

-> Capability

Create a new Capability with all required fields.

data CapabilityAccount'Variants

Defines the oneOf schema located at components.schemas.capability.properties.account.anyOf in the specification.

The account for which the capability enables functionality.

Constructors

CapabilityAccount'Text Text

CapabilityAccount'Account Account

Instances

Eq CapabilityAccount'Variants

Defined in StripeAPI.Types.Capability

Methods

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

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

Show CapabilityAccount'Variants

Defined in StripeAPI.Types.Capability

Methods

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

show :: CapabilityAccount'Variants -> String

showList :: [CapabilityAccount'Variants] -> ShowS

ToJSON CapabilityAccount'Variants

Defined in StripeAPI.Types.Capability

Methods

toJSON :: CapabilityAccount'Variants -> Value

toEncoding :: CapabilityAccount'Variants -> Encoding

toJSONList :: [CapabilityAccount'Variants] -> Value

toEncodingList :: [CapabilityAccount'Variants] -> Encoding

FromJSON CapabilityAccount'Variants

Defined in StripeAPI.Types.Capability

Methods

parseJSON :: Value -> Parser CapabilityAccount'Variants

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

data CapabilityStatus'

Defines the enum schema located at components.schemas.capability.properties.status in the specification.

The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`.

Constructors

CapabilityStatus'Other Value

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

CapabilityStatus'Typed Text

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

CapabilityStatus'EnumActive

Represents the JSON value "active"

CapabilityStatus'EnumDisabled

Represents the JSON value "disabled"

CapabilityStatus'EnumInactive

Represents the JSON value "inactive"

CapabilityStatus'EnumPending

Represents the JSON value "pending"

CapabilityStatus'EnumUnrequested

Represents the JSON value "unrequested"

Instances

Eq CapabilityStatus'

Defined in StripeAPI.Types.Capability

Methods

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

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

Show CapabilityStatus'

Defined in StripeAPI.Types.Capability

Methods

showsPrec :: Int -> CapabilityStatus' -> ShowS

show :: CapabilityStatus' -> String

showList :: [CapabilityStatus'] -> ShowS

ToJSON CapabilityStatus'

Defined in StripeAPI.Types.Capability

Methods

toJSON :: CapabilityStatus' -> Value

toEncoding :: CapabilityStatus' -> Encoding

toJSONList :: [CapabilityStatus'] -> Value

toEncodingList :: [CapabilityStatus'] -> Encoding

FromJSON CapabilityStatus'

Defined in StripeAPI.Types.Capability

Methods

parseJSON :: Value -> Parser CapabilityStatus'

parseJSONList :: Value -> Parser [CapabilityStatus']