HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostPaymentLinks

Contains the different functions to run the operation postPaymentLinks

  • 25 types
  • 16 values
  • Packagestripeapi-3.0.0.0
  • Exports41
  • LanguageHaskell2010
  • LicenceMIT
  • SourcePostPaymentLinks.hs

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON

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

Behavior after the purchase is complete.

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.after_completion.properties.hosted_confirmation in the specification.

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.after_completion.properties.redirect in the specification.

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.after_completion.properties.type in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

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

Configuration for automatic tax collection.

Instances4Eq, Show, FromJSON, ToJSON

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

Configuration for collecting the customer's billing address.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

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

Configure fields to gather active consent from customers.

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.consent_collection.properties.promotions in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

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

Configures whether checkout sessions created by this payment link create a Customer.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items in the specification.

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.adjustable_quantity in the specification.

Instances4Eq, Show, FromJSON, ToJSON

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

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.capture_method in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_types.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

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

Controls phone number collection settings during checkout.

We recommend that you review your privacy policy and check with your legal contacts.

Instances4Eq, Show, FromJSON, ToJSON

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

Configuration for collecting the customer's shipping address.

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_address_collection.properties.allowed_countries.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at paths./v1/payment_links.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items in the specification.

Instances4Eq, Show, FromJSON, ToJSON

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

Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

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

When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.

Instances4Eq, Show, FromJSON, ToJSON

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

Controls tax ID collection during checkout.

Instances4Eq, Show, FromJSON, ToJSON

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

The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.

Instances4Eq, Show, FromJSON, ToJSON

Represents a response of the operation postPaymentLinks.

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), PostPaymentLinksResponseError is used.

Constructors

Instances2Eq, Show