Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.BillingPortal_Configuration

Description

Contains the types generated from the schema BillingPortal_Configuration

Documentation

data BillingPortal'configuration Source #

Defines the object schema located at components.schemas.billing_portal.configuration in the specification.

A portal configuration describes the functionality and behavior of a portal session.

Constructors

BillingPortal'configuration

Fields

billingPortal'configurationActive :: Bool
active: Whether the configuration is active and can be used to create portal sessions.
billingPortal'configurationApplication :: Maybe Text
application: ID of the Connect Application that created the configuration.
Constraints:
- Maximum length of 5000
billingPortal'configurationBusinessProfile :: PortalBusinessProfile
business_profile:
billingPortal'configurationCreated :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
billingPortal'configurationDefaultReturnUrl :: Maybe Text
default_return_url: The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
Constraints:
- Maximum length of 5000
billingPortal'configurationFeatures :: PortalFeatures
features:
billingPortal'configurationId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
billingPortal'configurationIsDefault :: Bool
is_default: Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
billingPortal'configurationLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
billingPortal'configurationUpdated :: Int
updated: Time at which the object was last updated. Measured in seconds since the Unix epoch.

Instances

Instances details

Eq BillingPortal'configuration Source #
Instance details Defined in StripeAPI.Types.BillingPortal_Configuration Methods (==) :: BillingPortal'configuration -> BillingPortal'configuration -> Bool # (/=) :: BillingPortal'configuration -> BillingPortal'configuration -> Bool #
Show BillingPortal'configuration Source #
Instance details Defined in StripeAPI.Types.BillingPortal_Configuration Methods showsPrec :: Int -> BillingPortal'configuration -> ShowS # show :: BillingPortal'configuration -> String # showList :: [BillingPortal'configuration] -> ShowS #
ToJSON BillingPortal'configuration Source #
Instance details Defined in StripeAPI.Types.BillingPortal_Configuration Methods toJSON :: BillingPortal'configuration -> Value # toEncoding :: BillingPortal'configuration -> Encoding # toJSONList :: [BillingPortal'configuration] -> Value # toEncodingList :: [BillingPortal'configuration] -> Encoding #
FromJSON BillingPortal'configuration Source #
Instance details Defined in StripeAPI.Types.BillingPortal_Configuration Methods parseJSON :: Value -> Parser BillingPortal'configuration # parseJSONList :: Value -> Parser [BillingPortal'configuration] #

mkBillingPortal'configuration Source #

Arguments

:: Bool	`billingPortal'configurationActive`
-> PortalBusinessProfile	`billingPortal'configurationBusinessProfile`
-> Int	`billingPortal'configurationCreated`
-> PortalFeatures	`billingPortal'configurationFeatures`
-> Text	`billingPortal'configurationId`
-> Bool	`billingPortal'configurationIsDefault`
-> Bool	`billingPortal'configurationLivemode`
-> Int	`billingPortal'configurationUpdated`
-> BillingPortal'configuration

Create a new BillingPortal'configuration with all required fields.