StripeAPI.Types.BillingPortal_Configuration · stripeapi-3.0.0.0

datadata BillingPortal'configuration

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
- billingPortal'configurationActive :: Bool
  active: Whether the configuration is active and can be used to create portal sessions.
- billingPortal'configurationApplication :: Maybe (Nullable BillingPortal'configurationApplication'NonNullableVariants)
  application: ID of the Connect Application that created the configuration.
- 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 (Nullable 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'configurationMetadata :: Maybe (Nullable Object)
  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.
- billingPortal'configurationUpdated :: Int
  updated: Time at which the object was last updated. Measured in seconds since the Unix epoch.

Instances4Eq, Show, FromJSON, ToJSON

Eq BillingPortal'configurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration
Show BillingPortal'configurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration
FromJSON BillingPortal'configurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration
ToJSON BillingPortal'configurationDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration

valuemkBillingPortal'configuration

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

datadata BillingPortal'configurationApplication'NonNullableVariants

Defines the oneOf schema located at components.schemas.billing_portal.configuration.properties.application.anyOf in the specification.

ID of the Connect Application that created the configuration.

Constructors

BillingPortal'configurationApplication'NonNullableText Text
BillingPortal'configurationApplication'NonNullableApplication Application
BillingPortal'configurationApplication'NonNullableDeletedApplication DeletedApplication

Instances4Eq, Show, FromJSON, ToJSON

Eq BillingPortal'configurationApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration
Show BillingPortal'configurationApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration
FromJSON BillingPortal'configurationApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration
ToJSON BillingPortal'configurationApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Configuration