Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostBillingPortalSessions

Description

Contains the different functions to run the operation postBillingPortalSessions

Documentation

postBillingPortalSessions Source #

Arguments

:: forall m. MonadHTTP m
=> PostBillingPortalSessionsRequestBody	The request body to send
-> StripeT 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>

data PostBillingPortalSessionsRequestBody Source #

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

Fields

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

Instances

Instances details

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

mkPostBillingPortalSessionsRequestBody Source #

Arguments

:: Text	`postBillingPortalSessionsRequestBodyCustomer`
-> PostBillingPortalSessionsRequestBody

Create a new PostBillingPortalSessionsRequestBody with all required fields.

data PostBillingPortalSessionsResponse Source #

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.

Instances

Instances details

Eq PostBillingPortalSessionsResponse Source #
Instance details Defined in StripeAPI.Operations.PostBillingPortalSessions Methods (==) :: PostBillingPortalSessionsResponse -> PostBillingPortalSessionsResponse -> Bool # (/=) :: PostBillingPortalSessionsResponse -> PostBillingPortalSessionsResponse -> Bool #
Show PostBillingPortalSessionsResponse Source #
Instance details Defined in StripeAPI.Operations.PostBillingPortalSessions Methods showsPrec :: Int -> PostBillingPortalSessionsResponse -> ShowS # show :: PostBillingPortalSessionsResponse -> String # showList :: [PostBillingPortalSessionsResponse] -> ShowS #