Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostCustomers

Contains the different functions to run the operation postCustomers

22 types
12 values

Packagestripeapi-3.0.0.0
Exports34
LanguageHaskell2010
LicenceMIT
SourcePostCustomers.hs

valuepostCustomers

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

POST /v1/customers

<p>Creates a new customer object.</p>

datadata PostCustomersRequestBody

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

Constructors

PostCustomersRequestBody
- postCustomersRequestBodyAddress :: Maybe PostCustomersRequestBodyAddress'Variants
  address: The customer's address.
- postCustomersRequestBodyBalance :: Maybe Int
  balance: An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
- postCustomersRequestBodyCashBalance :: Maybe PostCustomersRequestBodyCashBalance'
  cash_balance: Balance information and default balance settings for this customer.
- postCustomersRequestBodyCoupon :: Maybe Text
  coupon
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyDescription :: Maybe Text
  description: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyEmail :: Maybe Text
  email: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
  Constraints:
  - Maximum length of 512
- postCustomersRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postCustomersRequestBodyInvoicePrefix :: Maybe Text
  invoice_prefix: The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyInvoiceSettings :: Maybe PostCustomersRequestBodyInvoiceSettings'
  invoice_settings: Default invoice settings for this customer.
- postCustomersRequestBodyMetadata :: Maybe PostCustomersRequestBodyMetadata'Variants
  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- postCustomersRequestBodyName :: Maybe Text
  name: The customer's full name or business name.
  Constraints:
  - Maximum length of 256
- postCustomersRequestBodyNextInvoiceSequence :: Maybe Int
  next_invoice_sequence: The sequence to be used on the customer's next invoice. Defaults to 1.
- postCustomersRequestBodyPaymentMethod :: Maybe Text
  payment_method
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyPhone :: Maybe Text
  phone: The customer's phone number.
  Constraints:
  - Maximum length of 20
- postCustomersRequestBodyPreferredLocales :: Maybe [Text]
  preferred_locales: Customer's preferred languages, ordered by preference.
- postCustomersRequestBodyPromotionCode :: Maybe Text
  promotion_code: The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping :: Maybe PostCustomersRequestBodyShipping'Variants
  shipping: The customer's shipping information. Appears on invoices emailed to this customer.
- postCustomersRequestBodySource :: Maybe Text
  source
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyTax :: Maybe PostCustomersRequestBodyTax'
  tax: Tax details about the customer.
- postCustomersRequestBodyTaxExempt :: Maybe PostCustomersRequestBodyTaxExempt'
  tax_exempt: The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
- postCustomersRequestBodyTaxIdData :: Maybe [PostCustomersRequestBodyTaxIdData']
  tax_id_data: The customer's tax IDs.
- postCustomersRequestBodyTestClock :: Maybe Text
  test_clock: ID of the test clock to attach to the customer.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBody :: PostCustomersRequestBody

Create a new PostCustomersRequestBody with all required fields.

datadata PostCustomersRequestBodyAddress'OneOf1

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

Constructors

PostCustomersRequestBodyAddress'OneOf1
- postCustomersRequestBodyAddress'OneOf1City :: Maybe Text
  city
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyAddress'OneOf1Country :: Maybe Text
  country
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyAddress'OneOf1Line1 :: Maybe Text
  line1
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyAddress'OneOf1Line2 :: Maybe Text
  line2
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyAddress'OneOf1PostalCode :: Maybe Text
  postal_code
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyAddress'OneOf1State :: Maybe Text
  state
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyAddress'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyAddress'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyAddress'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyAddress'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyAddress'OneOf1 :: PostCustomersRequestBodyAddress'OneOf1

Create a new PostCustomersRequestBodyAddress'OneOf1 with all required fields.

datadata PostCustomersRequestBodyAddress'Variants

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

The customer's address.

Constructors

PostCustomersRequestBodyAddress'EmptyString
Represents the JSON value ""
PostCustomersRequestBodyAddress'PostCustomersRequestBodyAddress'OneOf1 PostCustomersRequestBodyAddress'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyCashBalance'

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

Balance information and default balance settings for this customer.

Constructors

PostCustomersRequestBodyCashBalance'
- postCustomersRequestBodyCashBalance'Settings :: Maybe PostCustomersRequestBodyCashBalance'Settings'
  settings

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyCashBalance'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyCashBalance'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyCashBalance'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyCashBalance'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyCashBalance' :: PostCustomersRequestBodyCashBalance'

Create a new PostCustomersRequestBodyCashBalance' with all required fields.

datadata PostCustomersRequestBodyCashBalance'Settings'

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

Constructors

PostCustomersRequestBodyCashBalance'Settings'
- postCustomersRequestBodyCashBalance'Settings'ReconciliationMode :: Maybe PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'
  reconciliation_mode

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyCashBalance'Settings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyCashBalance'Settings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyCashBalance'Settings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyCashBalance'Settings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyCashBalance'Settings' :: PostCustomersRequestBodyCashBalance'Settings'

Create a new PostCustomersRequestBodyCashBalance'Settings' with all required fields.

datadata PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'

Defines the enum schema located at paths./v1/customers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.cash_balance.properties.settings.properties.reconciliation_mode in the specification.

Constructors

PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'EnumAutomatic
Represents the JSON value "automatic"
PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'EnumManual
Represents the JSON value "manual"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyCashBalance'Settings'ReconciliationMode'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyInvoiceSettings'

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

Default invoice settings for this customer.

Constructors

PostCustomersRequestBodyInvoiceSettings'
- postCustomersRequestBodyInvoiceSettings'CustomFields :: Maybe PostCustomersRequestBodyInvoiceSettings'CustomFields'Variants
  custom_fields
- postCustomersRequestBodyInvoiceSettings'DefaultPaymentMethod :: Maybe Text
  default_payment_method
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyInvoiceSettings'Footer :: Maybe Text
  footer
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyInvoiceSettings'RenderingOptions :: Maybe PostCustomersRequestBodyInvoiceSettings'RenderingOptions'Variants
  rendering_options

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyInvoiceSettings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyInvoiceSettings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyInvoiceSettings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyInvoiceSettings'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyInvoiceSettings' :: PostCustomersRequestBodyInvoiceSettings'

Create a new PostCustomersRequestBodyInvoiceSettings' with all required fields.

datadata PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1

Defines the object schema located at paths./v1/customers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.invoice_settings.properties.custom_fields.anyOf.items in the specification.

Constructors

PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1
- postCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Name :: Text
  name
  Constraints:
  - Maximum length of 30
- postCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Value :: Text
  value
  Constraints:
  - Maximum length of 30

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1

:: Text
postCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Name
-> Text
postCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1Value
-> PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1

Create a new PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1 with all required fields.

datadata PostCustomersRequestBodyInvoiceSettings'CustomFields'Variants

Defines the oneOf schema located at paths./v1/customers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.invoice_settings.properties.custom_fields.anyOf in the specification.

Constructors

PostCustomersRequestBodyInvoiceSettings'CustomFields'EmptyString
Represents the JSON value ""
PostCustomersRequestBodyInvoiceSettings'CustomFields'ListTPostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1 [PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1]

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyInvoiceSettings'CustomFields'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyInvoiceSettings'CustomFields'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyInvoiceSettings'CustomFields'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyInvoiceSettings'CustomFields'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1

Constructors

PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1
- postCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay :: Maybe PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'
  amount_tax_display

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

value

mkPostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1 :: PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1

Create a new PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1 with all required fields.

datadata PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'

Defines the enum schema located at paths./v1/customers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.invoice_settings.properties.rendering_options.anyOf.properties.amount_tax_display in the specification.

Constructors

PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'EnumEmptyString
Represents the JSON value ""
PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'EnumExcludeTax
Represents the JSON value "exclude_tax"
PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'EnumIncludeInclusiveTax
Represents the JSON value "include_inclusive_tax"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1AmountTaxDisplay'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyInvoiceSettings'RenderingOptions'Variants

Constructors

PostCustomersRequestBodyInvoiceSettings'RenderingOptions'EmptyString
Represents the JSON value ""
PostCustomersRequestBodyInvoiceSettings'RenderingOptions'PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1 PostCustomersRequestBodyInvoiceSettings'RenderingOptions'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyInvoiceSettings'RenderingOptions'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyInvoiceSettings'RenderingOptions'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyInvoiceSettings'RenderingOptions'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyInvoiceSettings'RenderingOptions'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyMetadata'Variants

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

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostCustomersRequestBodyMetadata'EmptyString
Represents the JSON value ""
PostCustomersRequestBodyMetadata'Object Object

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyShipping'OneOf1

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

Constructors

PostCustomersRequestBodyShipping'OneOf1
- postCustomersRequestBodyShipping'OneOf1Address :: PostCustomersRequestBodyShipping'OneOf1Address'
  address
- postCustomersRequestBodyShipping'OneOf1Name :: Text
  name
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping'OneOf1Phone :: Maybe Text
  phone
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyShipping'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyShipping'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyShipping'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyShipping'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyShipping'OneOf1

:: PostCustomersRequestBodyShipping'OneOf1Address'
postCustomersRequestBodyShipping'OneOf1Address
-> Text
postCustomersRequestBodyShipping'OneOf1Name
-> PostCustomersRequestBodyShipping'OneOf1

Create a new PostCustomersRequestBodyShipping'OneOf1 with all required fields.

datadata PostCustomersRequestBodyShipping'OneOf1Address'

Defines the object schema located at paths./v1/customers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping.anyOf.properties.address in the specification.

Constructors

PostCustomersRequestBodyShipping'OneOf1Address'
- postCustomersRequestBodyShipping'OneOf1Address'City :: Maybe Text
  city
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping'OneOf1Address'Country :: Maybe Text
  country
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping'OneOf1Address'Line1 :: Maybe Text
  line1
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping'OneOf1Address'Line2 :: Maybe Text
  line2
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping'OneOf1Address'PostalCode :: Maybe Text
  postal_code
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyShipping'OneOf1Address'State :: Maybe Text
  state
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyShipping'OneOf1Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyShipping'OneOf1Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyShipping'OneOf1Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyShipping'OneOf1Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyShipping'OneOf1Address' :: PostCustomersRequestBodyShipping'OneOf1Address'

Create a new PostCustomersRequestBodyShipping'OneOf1Address' with all required fields.

datadata PostCustomersRequestBodyShipping'Variants

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

The customer's shipping information. Appears on invoices emailed to this customer.

Constructors

PostCustomersRequestBodyShipping'EmptyString
Represents the JSON value ""
PostCustomersRequestBodyShipping'PostCustomersRequestBodyShipping'OneOf1 PostCustomersRequestBodyShipping'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyShipping'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyShipping'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyShipping'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyShipping'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyTax'

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

Tax details about the customer.

Constructors

PostCustomersRequestBodyTax'
- postCustomersRequestBodyTax'IpAddress :: Maybe PostCustomersRequestBodyTax'IpAddress'Variants
  ip_address

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyTax'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyTax'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyTax'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyTax'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyTax' :: PostCustomersRequestBodyTax'

Create a new PostCustomersRequestBodyTax' with all required fields.

datadata PostCustomersRequestBodyTax'IpAddress'Variants

Defines the oneOf schema located at paths./v1/customers.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax.properties.ip_address.anyOf in the specification.

Constructors

PostCustomersRequestBodyTax'IpAddress'EmptyString
Represents the JSON value ""
PostCustomersRequestBodyTax'IpAddress'Text Text

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyTax'IpAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyTax'IpAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyTax'IpAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyTax'IpAddress'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyTaxExempt'

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

The customer's tax exemption. One of `none`, `exempt`, or `reverse`.

Constructors

PostCustomersRequestBodyTaxExempt'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostCustomersRequestBodyTaxExempt'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostCustomersRequestBodyTaxExempt'EnumEmptyString
Represents the JSON value ""
PostCustomersRequestBodyTaxExempt'EnumExempt
Represents the JSON value "exempt"
PostCustomersRequestBodyTaxExempt'EnumNone
Represents the JSON value "none"
PostCustomersRequestBodyTaxExempt'EnumReverse
Represents the JSON value "reverse"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyTaxExempt'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyTaxExempt'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyTaxExempt'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyTaxExempt'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersRequestBodyTaxIdData'

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

Constructors

PostCustomersRequestBodyTaxIdData'
- postCustomersRequestBodyTaxIdData'Type :: PostCustomersRequestBodyTaxIdData'Type'
  type
  Constraints:
  - Maximum length of 5000
- postCustomersRequestBodyTaxIdData'Value :: Text
  value

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyTaxIdData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyTaxIdData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyTaxIdData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyTaxIdData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

valuemkPostCustomersRequestBodyTaxIdData'

:: PostCustomersRequestBodyTaxIdData'Type'
postCustomersRequestBodyTaxIdData'Type
-> Text
postCustomersRequestBodyTaxIdData'Value
-> PostCustomersRequestBodyTaxIdData'

Create a new PostCustomersRequestBodyTaxIdData' with all required fields.

datadata PostCustomersRequestBodyTaxIdData'Type'

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

Constructors

PostCustomersRequestBodyTaxIdData'Type'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostCustomersRequestBodyTaxIdData'Type'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostCustomersRequestBodyTaxIdData'Type'EnumAeTrn
Represents the JSON value "ae_trn"
PostCustomersRequestBodyTaxIdData'Type'EnumAuAbn
Represents the JSON value "au_abn"
PostCustomersRequestBodyTaxIdData'Type'EnumAuArn
Represents the JSON value "au_arn"
PostCustomersRequestBodyTaxIdData'Type'EnumBgUic
Represents the JSON value "bg_uic"
PostCustomersRequestBodyTaxIdData'Type'EnumBrCnpj
Represents the JSON value "br_cnpj"
PostCustomersRequestBodyTaxIdData'Type'EnumBrCpf
Represents the JSON value "br_cpf"
PostCustomersRequestBodyTaxIdData'Type'EnumCaBn
Represents the JSON value "ca_bn"
PostCustomersRequestBodyTaxIdData'Type'EnumCaGstHst
Represents the JSON value "ca_gst_hst"
PostCustomersRequestBodyTaxIdData'Type'EnumCaPstBc
Represents the JSON value "ca_pst_bc"
PostCustomersRequestBodyTaxIdData'Type'EnumCaPstMb
Represents the JSON value "ca_pst_mb"
PostCustomersRequestBodyTaxIdData'Type'EnumCaPstSk
Represents the JSON value "ca_pst_sk"
PostCustomersRequestBodyTaxIdData'Type'EnumCaQst
Represents the JSON value "ca_qst"
PostCustomersRequestBodyTaxIdData'Type'EnumChVat
Represents the JSON value "ch_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumClTin
Represents the JSON value "cl_tin"
PostCustomersRequestBodyTaxIdData'Type'EnumEsCif
Represents the JSON value "es_cif"
PostCustomersRequestBodyTaxIdData'Type'EnumEuOssVat
Represents the JSON value "eu_oss_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumEuVat
Represents the JSON value "eu_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumGbVat
Represents the JSON value "gb_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumGeVat
Represents the JSON value "ge_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumHkBr
Represents the JSON value "hk_br"
PostCustomersRequestBodyTaxIdData'Type'EnumHuTin
Represents the JSON value "hu_tin"
PostCustomersRequestBodyTaxIdData'Type'EnumIdNpwp
Represents the JSON value "id_npwp"
PostCustomersRequestBodyTaxIdData'Type'EnumIlVat
Represents the JSON value "il_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumInGst
Represents the JSON value "in_gst"
PostCustomersRequestBodyTaxIdData'Type'EnumIsVat
Represents the JSON value "is_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumJpCn
Represents the JSON value "jp_cn"
PostCustomersRequestBodyTaxIdData'Type'EnumJpRn
Represents the JSON value "jp_rn"
PostCustomersRequestBodyTaxIdData'Type'EnumKrBrn
Represents the JSON value "kr_brn"
PostCustomersRequestBodyTaxIdData'Type'EnumLiUid
Represents the JSON value "li_uid"
PostCustomersRequestBodyTaxIdData'Type'EnumMxRfc
Represents the JSON value "mx_rfc"
PostCustomersRequestBodyTaxIdData'Type'EnumMyFrp
Represents the JSON value "my_frp"
PostCustomersRequestBodyTaxIdData'Type'EnumMyItn
Represents the JSON value "my_itn"
PostCustomersRequestBodyTaxIdData'Type'EnumMySst
Represents the JSON value "my_sst"
PostCustomersRequestBodyTaxIdData'Type'EnumNoVat
Represents the JSON value "no_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumNzGst
Represents the JSON value "nz_gst"
PostCustomersRequestBodyTaxIdData'Type'EnumRuInn
Represents the JSON value "ru_inn"
PostCustomersRequestBodyTaxIdData'Type'EnumRuKpp
Represents the JSON value "ru_kpp"
PostCustomersRequestBodyTaxIdData'Type'EnumSaVat
Represents the JSON value "sa_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumSgGst
Represents the JSON value "sg_gst"
PostCustomersRequestBodyTaxIdData'Type'EnumSgUen
Represents the JSON value "sg_uen"
PostCustomersRequestBodyTaxIdData'Type'EnumSiTin
Represents the JSON value "si_tin"
PostCustomersRequestBodyTaxIdData'Type'EnumThVat
Represents the JSON value "th_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumTwVat
Represents the JSON value "tw_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumUaVat
Represents the JSON value "ua_vat"
PostCustomersRequestBodyTaxIdData'Type'EnumUsEin
Represents the JSON value "us_ein"
PostCustomersRequestBodyTaxIdData'Type'EnumZaVat
Represents the JSON value "za_vat"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersRequestBodyTaxIdData'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersRequestBodyTaxIdData'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
FromJSON PostCustomersRequestBodyTaxIdData'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
ToJSON PostCustomersRequestBodyTaxIdData'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers

datadata PostCustomersResponse

Represents a response of the operation postCustomers.

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

Constructors

PostCustomersResponseError String
Means either no matching case available or a parse error
PostCustomersResponse200 Customer
Successful response.
PostCustomersResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostCustomersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers
Show PostCustomersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomers