stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostBillingPortalConfigurations

Description

Contains the different functions to run the operation postBillingPortalConfigurations

Synopsis

Documentation

postBillingPortalConfigurations Source #

Arguments

:: forall m. MonadHTTP m 
=> PostBillingPortalConfigurationsRequestBody

The request body to send

-> StripeT m (Response PostBillingPortalConfigurationsResponse)

Monadic computation which returns the result of the operation

POST /v1/billing_portal/configurations

<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>

data PostBillingPortalConfigurationsRequestBody Source #

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

Constructors

PostBillingPortalConfigurationsRequestBody 

Fields

data PostBillingPortalConfigurationsRequestBodyBusinessProfile' Source #

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

The business information shown to customers in the portal.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyBusinessProfile' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyBusinessProfile' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyBusinessProfile' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyBusinessProfile' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyDefaultReturnUrl'Variants Source #

Defines the oneOf schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_return_url.anyOf in the specification.

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.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyDefaultReturnUrl'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyDefaultReturnUrl'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyDefaultReturnUrl'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyDefaultReturnUrl'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures' Source #

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

Information about the features available in the portal.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate' Source #

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

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'OneOf1 Source #

Defines the enum schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.customer_update.properties.allowed_updates.anyOf.items in the specification.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'Variants Source #

Defines the oneOf schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.customer_update.properties.allowed_updates.anyOf in the specification.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'CustomerUpdate'AllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'InvoiceHistory' Source #

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

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'InvoiceHistory' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'InvoiceHistory' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'InvoiceHistory' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'InvoiceHistory' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'PaymentMethodUpdate' Source #

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

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'PaymentMethodUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'PaymentMethodUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'PaymentMethodUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'PaymentMethodUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel' Source #

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

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode' Source #

Defines the enum schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_cancel.properties.mode in the specification.

Constructors

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode'EnumAtPeriodEnd

Represents the JSON value "at_period_end"

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode'EnumImmediately

Represents the JSON value "immediately"

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'Mode' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior' Source #

Defines the enum schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_cancel.properties.proration_behavior in the specification.

Constructors

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior'EnumAlwaysInvoice

Represents the JSON value "always_invoice"

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior'EnumCreateProrations

Represents the JSON value "create_prorations"

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior'EnumNone

Represents the JSON value "none"

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionCancel'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionPause' Source #

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

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionPause' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionPause' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionPause' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionPause' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate' Source #

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

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'OneOf1 Source #

Defines the enum schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_update.properties.default_allowed_updates.anyOf.items in the specification.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'Variants Source #

Defines the oneOf schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_update.properties.default_allowed_updates.anyOf in the specification.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'DefaultAllowedUpdates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'OneOf1 Source #

Defines the object schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_update.properties.products.anyOf.items in the specification.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'Variants Source #

Defines the oneOf schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_update.properties.products.anyOf in the specification.

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'Products'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

data PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior' Source #

Defines the enum schema located at paths./v1/billing_portal/configurations.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.features.properties.subscription_update.properties.proration_behavior in the specification.

Constructors

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior'EnumAlwaysInvoice

Represents the JSON value "always_invoice"

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior'EnumCreateProrations

Represents the JSON value "create_prorations"

PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior'EnumNone

Represents the JSON value "none"

Instances

Instances details
Eq PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

Show PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

ToJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations

FromJSON PostBillingPortalConfigurationsRequestBodyFeatures'SubscriptionUpdate'ProrationBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostBillingPortalConfigurations