StripeAPI.Types.BillingPortal_Session

Contains the types generated from the schema BillingPortal_Session

Documentation

data BillingPortal'session

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

The Billing customer portal is a Stripe-hosted UI for subscription and billing management.

A portal configuration describes the functionality and features that you want to provide to your customers through the portal.

A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details.

Learn more in the product overview and integration guide.

Constructors

BillingPortal'session

Fields

• billingPortal'sessionConfiguration :: BillingPortal'sessionConfiguration'Variants

  configuration: The configuration used by this session, describing the features available.

• billingPortal'sessionCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• billingPortal'sessionCustomer :: Text

  customer: The ID of the customer for this session.

  Constraints:

  • Maximum length of 5000
• billingPortal'sessionId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• billingPortal'sessionLivemode :: 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'sessionOnBehalfOf :: Maybe Text

  on_behalf_of: The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the docs. Use the Accounts API to modify the `on_behalf_of` account's branding settings, which the portal displays.

  Constraints:

  • Maximum length of 5000
• billingPortal'sessionReturnUrl :: Text

  return_url: The URL to redirect customers to when they click on the portal's link to return to your website.

  Constraints:

  • Maximum length of 5000
• billingPortal'sessionUrl :: Text

  url: The short-lived URL of the session that gives customers access to the customer portal.

  Constraints:

  • Maximum length of 5000

Instances

Eq BillingPortal'session

Defined in StripeAPI.Types.BillingPortal_Session

Methods

(==) :: BillingPortal'session -> BillingPortal'session -> Bool

(/=) :: BillingPortal'session -> BillingPortal'session -> Bool

Show BillingPortal'session

Defined in StripeAPI.Types.BillingPortal_Session

Methods

showsPrec :: Int -> BillingPortal'session -> ShowS

show :: BillingPortal'session -> String

showList :: [BillingPortal'session] -> ShowS

ToJSON BillingPortal'session

Defined in StripeAPI.Types.BillingPortal_Session

Methods

toJSON :: BillingPortal'session -> Value

toEncoding :: BillingPortal'session -> Encoding

toJSONList :: [BillingPortal'session] -> Value

toEncodingList :: [BillingPortal'session] -> Encoding

FromJSON BillingPortal'session

Defined in StripeAPI.Types.BillingPortal_Session

Methods

parseJSON :: Value -> Parser BillingPortal'session

parseJSONList :: Value -> Parser [BillingPortal'session]

mkBillingPortal'session

Arguments

:: BillingPortal'sessionConfiguration'Variants

billingPortal'sessionConfiguration

-> Int

billingPortal'sessionCreated

-> Text

billingPortal'sessionCustomer

-> Text

billingPortal'sessionId

-> Bool

billingPortal'sessionLivemode

-> Text

billingPortal'sessionReturnUrl

-> Text

billingPortal'sessionUrl

-> BillingPortal'session

Create a new BillingPortal'session with all required fields.

data BillingPortal'sessionConfiguration'Variants

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

The configuration used by this session, describing the features available.

Constructors

BillingPortal'sessionConfiguration'Text Text

BillingPortal'sessionConfiguration'BillingPortal'configuration BillingPortal'configuration

Instances

Eq BillingPortal'sessionConfiguration'Variants

Defined in StripeAPI.Types.BillingPortal_Session

Methods

(==) :: BillingPortal'sessionConfiguration'Variants -> BillingPortal'sessionConfiguration'Variants -> Bool

(/=) :: BillingPortal'sessionConfiguration'Variants -> BillingPortal'sessionConfiguration'Variants -> Bool

Show BillingPortal'sessionConfiguration'Variants

Defined in StripeAPI.Types.BillingPortal_Session

Methods

showsPrec :: Int -> BillingPortal'sessionConfiguration'Variants -> ShowS

show :: BillingPortal'sessionConfiguration'Variants -> String

showList :: [BillingPortal'sessionConfiguration'Variants] -> ShowS

ToJSON BillingPortal'sessionConfiguration'Variants

Defined in StripeAPI.Types.BillingPortal_Session

Methods

toJSON :: BillingPortal'sessionConfiguration'Variants -> Value

toEncoding :: BillingPortal'sessionConfiguration'Variants -> Encoding

toJSONList :: [BillingPortal'sessionConfiguration'Variants] -> Value

toEncodingList :: [BillingPortal'sessionConfiguration'Variants] -> Encoding

FromJSON BillingPortal'sessionConfiguration'Variants

Defined in StripeAPI.Types.BillingPortal_Session

Methods

parseJSON :: Value -> Parser BillingPortal'sessionConfiguration'Variants

parseJSONList :: Value -> Parser [BillingPortal'sessionConfiguration'Variants]