Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostBillingPortalSessions

Contains the different functions to run the operation postBillingPortalSessions

3 types
2 values

Packagestripeapi-3.0.0.0
Exports5
LanguageHaskell2010
LicenceMIT
SourcePostBillingPortalSessions.hs

valuepostBillingPortalSessions

:: MonadHTTP m
=> PostBillingPortalSessionsRequestBody
The request body to send
-> ClientT m (Response PostBillingPortalSessionsResponse)
Monadic computation which returns the result of the operation

POST /v1/billing_portal/sessions

<p>Creates a session of the customer portal.</p>

datadata PostBillingPortalSessionsRequestBody

Defines the object schema located at paths./v1/billing_portal/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostBillingPortalSessionsRequestBody
- postBillingPortalSessionsRequestBodyConfiguration :: Maybe Text
  configuration: The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
  Constraints:
  - Maximum length of 5000
- postBillingPortalSessionsRequestBodyCustomer :: Text
  customer: The ID of an existing customer.
  Constraints:
  - Maximum length of 5000
- postBillingPortalSessionsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postBillingPortalSessionsRequestBodyLocale :: Maybe PostBillingPortalSessionsRequestBodyLocale'
  locale: The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
- postBillingPortalSessionsRequestBodyOnBehalfOf :: Maybe Text
  on_behalf_of: The `on_behalf_of` account to use for this session. 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.
- postBillingPortalSessionsRequestBodyReturnUrl :: Maybe Text
  return_url: The default URL to redirect customers to when they click on the portal's link to return to your website.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostBillingPortalSessionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
Show PostBillingPortalSessionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
FromJSON PostBillingPortalSessionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
ToJSON PostBillingPortalSessionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions

valuemkPostBillingPortalSessionsRequestBody

:: Text
postBillingPortalSessionsRequestBodyCustomer
-> PostBillingPortalSessionsRequestBody

Create a new PostBillingPortalSessionsRequestBody with all required fields.

datadata PostBillingPortalSessionsRequestBodyLocale'

Defines the enum schema located at paths./v1/billing_portal/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.locale in the specification.

The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.

Constructors

PostBillingPortalSessionsRequestBodyLocale'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostBillingPortalSessionsRequestBodyLocale'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostBillingPortalSessionsRequestBodyLocale'EnumAuto
Represents the JSON value "auto"
PostBillingPortalSessionsRequestBodyLocale'EnumBg
Represents the JSON value "bg"
PostBillingPortalSessionsRequestBodyLocale'EnumCs
Represents the JSON value "cs"
PostBillingPortalSessionsRequestBodyLocale'EnumDa
Represents the JSON value "da"
PostBillingPortalSessionsRequestBodyLocale'EnumDe
Represents the JSON value "de"
PostBillingPortalSessionsRequestBodyLocale'EnumEl
Represents the JSON value "el"
PostBillingPortalSessionsRequestBodyLocale'EnumEn
Represents the JSON value "en"
PostBillingPortalSessionsRequestBodyLocale'EnumEnAU
Represents the JSON value "en-AU"
PostBillingPortalSessionsRequestBodyLocale'EnumEnCA
Represents the JSON value "en-CA"
PostBillingPortalSessionsRequestBodyLocale'EnumEnGB
Represents the JSON value "en-GB"
PostBillingPortalSessionsRequestBodyLocale'EnumEnIE
Represents the JSON value "en-IE"
PostBillingPortalSessionsRequestBodyLocale'EnumEnIN
Represents the JSON value "en-IN"
PostBillingPortalSessionsRequestBodyLocale'EnumEnNZ
Represents the JSON value "en-NZ"
PostBillingPortalSessionsRequestBodyLocale'EnumEnSG
Represents the JSON value "en-SG"
PostBillingPortalSessionsRequestBodyLocale'EnumEs
Represents the JSON value "es"
PostBillingPortalSessionsRequestBodyLocale'EnumEs_419
Represents the JSON value "es-419"
PostBillingPortalSessionsRequestBodyLocale'EnumEt
Represents the JSON value "et"
PostBillingPortalSessionsRequestBodyLocale'EnumFi
Represents the JSON value "fi"
PostBillingPortalSessionsRequestBodyLocale'EnumFil
Represents the JSON value "fil"
PostBillingPortalSessionsRequestBodyLocale'EnumFr
Represents the JSON value "fr"
PostBillingPortalSessionsRequestBodyLocale'EnumFrCA
Represents the JSON value "fr-CA"
PostBillingPortalSessionsRequestBodyLocale'EnumHr
Represents the JSON value "hr"
PostBillingPortalSessionsRequestBodyLocale'EnumHu
Represents the JSON value "hu"
PostBillingPortalSessionsRequestBodyLocale'EnumId
Represents the JSON value "id"
PostBillingPortalSessionsRequestBodyLocale'EnumIt
Represents the JSON value "it"
PostBillingPortalSessionsRequestBodyLocale'EnumJa
Represents the JSON value "ja"
PostBillingPortalSessionsRequestBodyLocale'EnumKo
Represents the JSON value "ko"
PostBillingPortalSessionsRequestBodyLocale'EnumLt
Represents the JSON value "lt"
PostBillingPortalSessionsRequestBodyLocale'EnumLv
Represents the JSON value "lv"
PostBillingPortalSessionsRequestBodyLocale'EnumMs
Represents the JSON value "ms"
PostBillingPortalSessionsRequestBodyLocale'EnumMt
Represents the JSON value "mt"
PostBillingPortalSessionsRequestBodyLocale'EnumNb
Represents the JSON value "nb"
PostBillingPortalSessionsRequestBodyLocale'EnumNl
Represents the JSON value "nl"
PostBillingPortalSessionsRequestBodyLocale'EnumPl
Represents the JSON value "pl"
PostBillingPortalSessionsRequestBodyLocale'EnumPt
Represents the JSON value "pt"
PostBillingPortalSessionsRequestBodyLocale'EnumPtBR
Represents the JSON value "pt-BR"
PostBillingPortalSessionsRequestBodyLocale'EnumRo
Represents the JSON value "ro"
PostBillingPortalSessionsRequestBodyLocale'EnumRu
Represents the JSON value "ru"
PostBillingPortalSessionsRequestBodyLocale'EnumSk
Represents the JSON value "sk"
PostBillingPortalSessionsRequestBodyLocale'EnumSl
Represents the JSON value "sl"
PostBillingPortalSessionsRequestBodyLocale'EnumSv
Represents the JSON value "sv"
PostBillingPortalSessionsRequestBodyLocale'EnumTh
Represents the JSON value "th"
PostBillingPortalSessionsRequestBodyLocale'EnumTr
Represents the JSON value "tr"
PostBillingPortalSessionsRequestBodyLocale'EnumVi
Represents the JSON value "vi"
PostBillingPortalSessionsRequestBodyLocale'EnumZh
Represents the JSON value "zh"
PostBillingPortalSessionsRequestBodyLocale'EnumZhHK
Represents the JSON value "zh-HK"
PostBillingPortalSessionsRequestBodyLocale'EnumZhTW
Represents the JSON value "zh-TW"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostBillingPortalSessionsRequestBodyLocale'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
Show PostBillingPortalSessionsRequestBodyLocale'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
FromJSON PostBillingPortalSessionsRequestBodyLocale'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
ToJSON PostBillingPortalSessionsRequestBodyLocale'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions

datadata PostBillingPortalSessionsResponse

Represents a response of the operation postBillingPortalSessions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostBillingPortalSessionsResponseError is used.

Constructors

PostBillingPortalSessionsResponseError String
Means either no matching case available or a parse error
PostBillingPortalSessionsResponse200 BillingPortal'session
Successful response.
PostBillingPortalSessionsResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostBillingPortalSessionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions
Show PostBillingPortalSessionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostBillingPortalSessions