| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCustomersCustomer
Description
Contains the different functions to run the operation postCustomersCustomer
Synopsis
- postCustomersCustomer :: forall m. MonadHTTP m => Text -> Maybe PostCustomersCustomerRequestBody -> StripeT m (Response PostCustomersCustomerResponse)
- data PostCustomersCustomerRequestBody = PostCustomersCustomerRequestBody {
- postCustomersCustomerRequestBodyAddress :: Maybe PostCustomersCustomerRequestBodyAddress'Variants
- postCustomersCustomerRequestBodyBalance :: Maybe Int
- postCustomersCustomerRequestBodyBankAccount :: Maybe PostCustomersCustomerRequestBodyBankAccount'Variants
- postCustomersCustomerRequestBodyCard :: Maybe PostCustomersCustomerRequestBodyCard'Variants
- postCustomersCustomerRequestBodyCoupon :: Maybe Text
- postCustomersCustomerRequestBodyDefaultAlipayAccount :: Maybe Text
- postCustomersCustomerRequestBodyDefaultBankAccount :: Maybe Text
- postCustomersCustomerRequestBodyDefaultCard :: Maybe Text
- postCustomersCustomerRequestBodyDefaultSource :: Maybe Text
- postCustomersCustomerRequestBodyDescription :: Maybe Text
- postCustomersCustomerRequestBodyEmail :: Maybe Text
- postCustomersCustomerRequestBodyExpand :: Maybe [Text]
- postCustomersCustomerRequestBodyInvoicePrefix :: Maybe Text
- postCustomersCustomerRequestBodyInvoiceSettings :: Maybe PostCustomersCustomerRequestBodyInvoiceSettings'
- postCustomersCustomerRequestBodyMetadata :: Maybe PostCustomersCustomerRequestBodyMetadata'Variants
- postCustomersCustomerRequestBodyName :: Maybe Text
- postCustomersCustomerRequestBodyNextInvoiceSequence :: Maybe Int
- postCustomersCustomerRequestBodyPhone :: Maybe Text
- postCustomersCustomerRequestBodyPreferredLocales :: Maybe [Text]
- postCustomersCustomerRequestBodyPromotionCode :: Maybe Text
- postCustomersCustomerRequestBodyShipping :: Maybe PostCustomersCustomerRequestBodyShipping'Variants
- postCustomersCustomerRequestBodySource :: Maybe Text
- postCustomersCustomerRequestBodyTax :: Maybe PostCustomersCustomerRequestBodyTax'
- postCustomersCustomerRequestBodyTaxExempt :: Maybe PostCustomersCustomerRequestBodyTaxExempt'
- postCustomersCustomerRequestBodyTrialEnd :: Maybe PostCustomersCustomerRequestBodyTrialEnd'Variants
- mkPostCustomersCustomerRequestBody :: PostCustomersCustomerRequestBody
- data PostCustomersCustomerRequestBodyAddress'OneOf1 = PostCustomersCustomerRequestBodyAddress'OneOf1 {
- postCustomersCustomerRequestBodyAddress'OneOf1City :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf1Country :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf1Line1 :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf1Line2 :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf1PostalCode :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf1State :: Maybe Text
- mkPostCustomersCustomerRequestBodyAddress'OneOf1 :: PostCustomersCustomerRequestBodyAddress'OneOf1
- data PostCustomersCustomerRequestBodyAddress'Variants
- data PostCustomersCustomerRequestBodyBankAccount'OneOf1 = PostCustomersCustomerRequestBodyBankAccount'OneOf1 {
- postCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderName :: Maybe Text
- postCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType :: Maybe PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'
- postCustomersCustomerRequestBodyBankAccount'OneOf1AccountNumber :: Text
- postCustomersCustomerRequestBodyBankAccount'OneOf1Country :: Text
- postCustomersCustomerRequestBodyBankAccount'OneOf1Currency :: Maybe Text
- postCustomersCustomerRequestBodyBankAccount'OneOf1RoutingNumber :: Maybe Text
- mkPostCustomersCustomerRequestBodyBankAccount'OneOf1 :: Text -> Text -> PostCustomersCustomerRequestBodyBankAccount'OneOf1
- data PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'
- = PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'Other Value
- | PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'Typed Text
- | PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'EnumCompany
- | PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'EnumIndividual
- data PostCustomersCustomerRequestBodyBankAccount'Variants
- data PostCustomersCustomerRequestBodyCard'OneOf1 = PostCustomersCustomerRequestBodyCard'OneOf1 {
- postCustomersCustomerRequestBodyCard'OneOf1AddressCity :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1AddressCountry :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1AddressLine1 :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1AddressLine2 :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1AddressState :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1AddressZip :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1Cvc :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1ExpMonth :: Int
- postCustomersCustomerRequestBodyCard'OneOf1ExpYear :: Int
- postCustomersCustomerRequestBodyCard'OneOf1Metadata :: Maybe Object
- postCustomersCustomerRequestBodyCard'OneOf1Name :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf1Number :: Text
- mkPostCustomersCustomerRequestBodyCard'OneOf1 :: Int -> Int -> Text -> PostCustomersCustomerRequestBodyCard'OneOf1
- data PostCustomersCustomerRequestBodyCard'Variants
- data PostCustomersCustomerRequestBodyInvoiceSettings' = PostCustomersCustomerRequestBodyInvoiceSettings' {}
- mkPostCustomersCustomerRequestBodyInvoiceSettings' :: PostCustomersCustomerRequestBodyInvoiceSettings'
- data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 = PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 {}
- mkPostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 :: Text -> Text -> PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1
- data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'Variants
- data PostCustomersCustomerRequestBodyMetadata'Variants
- data PostCustomersCustomerRequestBodyShipping'OneOf1 = PostCustomersCustomerRequestBodyShipping'OneOf1 {}
- mkPostCustomersCustomerRequestBodyShipping'OneOf1 :: PostCustomersCustomerRequestBodyShipping'OneOf1Address' -> Text -> PostCustomersCustomerRequestBodyShipping'OneOf1
- data PostCustomersCustomerRequestBodyShipping'OneOf1Address' = PostCustomersCustomerRequestBodyShipping'OneOf1Address' {
- postCustomersCustomerRequestBodyShipping'OneOf1Address'City :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf1Address'Country :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf1Address'Line1 :: Text
- postCustomersCustomerRequestBodyShipping'OneOf1Address'Line2 :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf1Address'PostalCode :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf1Address'State :: Maybe Text
- mkPostCustomersCustomerRequestBodyShipping'OneOf1Address' :: Text -> PostCustomersCustomerRequestBodyShipping'OneOf1Address'
- data PostCustomersCustomerRequestBodyShipping'Variants
- data PostCustomersCustomerRequestBodyTax' = PostCustomersCustomerRequestBodyTax' {}
- mkPostCustomersCustomerRequestBodyTax' :: PostCustomersCustomerRequestBodyTax'
- data PostCustomersCustomerRequestBodyTax'IpAddress'Variants
- data PostCustomersCustomerRequestBodyTaxExempt'
- = PostCustomersCustomerRequestBodyTaxExempt'Other Value
- | PostCustomersCustomerRequestBodyTaxExempt'Typed Text
- | PostCustomersCustomerRequestBodyTaxExempt'EnumEmptyString
- | PostCustomersCustomerRequestBodyTaxExempt'EnumExempt
- | PostCustomersCustomerRequestBodyTaxExempt'EnumNone
- | PostCustomersCustomerRequestBodyTaxExempt'EnumReverse
- data PostCustomersCustomerRequestBodyTrialEnd'Variants
- data PostCustomersCustomerResponse
Documentation
postCustomersCustomer Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | customer | Constraints: Maximum length of 5000 |
| -> Maybe PostCustomersCustomerRequestBody | The request body to send |
| -> StripeT m (Response PostCustomersCustomerResponse) | Monadic computation which returns the result of the operation |
POST /v1/customers/{customer}<p>Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the <strong>source</strong> parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the <strong>source</strong> parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the <code>past_due</code> state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the <strong>default_source</strong> for a customer will not trigger this behavior.</p>
<p>This request accepts mostly the same arguments as the customer creation call.</p>
data PostCustomersCustomerRequestBody Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostCustomersCustomerRequestBody | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBody :: PostCustomersCustomerRequestBody Source #
Create a new PostCustomersCustomerRequestBody with all required fields.
data PostCustomersCustomerRequestBodyAddress'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address.anyOf in the specification.
Constructors
| PostCustomersCustomerRequestBodyAddress'OneOf1 | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBodyAddress'OneOf1 :: PostCustomersCustomerRequestBodyAddress'OneOf1 Source #
Create a new PostCustomersCustomerRequestBodyAddress'OneOf1 with all required fields.
data PostCustomersCustomerRequestBodyAddress'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address.anyOf in the specification.
The customer's address.
Constructors
Instances
data PostCustomersCustomerRequestBodyBankAccount'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.bank_account.anyOf in the specification.
Constructors
| PostCustomersCustomerRequestBodyBankAccount'OneOf1 | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBodyBankAccount'OneOf1 Source #
Arguments
| :: Text |
|
| -> Text | |
| -> PostCustomersCustomerRequestBodyBankAccount'OneOf1 |
Create a new PostCustomersCustomerRequestBodyBankAccount'OneOf1 with all required fields.
data PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType' Source #
Defines the enum schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.bank_account.anyOf.properties.account_holder_type in the specification.
Constructors
| PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'EnumCompany | Represents the JSON value |
| PostCustomersCustomerRequestBodyBankAccount'OneOf1AccountHolderType'EnumIndividual | Represents the JSON value |
Instances
data PostCustomersCustomerRequestBodyBankAccount'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.bank_account.anyOf in the specification.
Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
Constructors
| PostCustomersCustomerRequestBodyBankAccount'PostCustomersCustomerRequestBodyBankAccount'OneOf1 PostCustomersCustomerRequestBodyBankAccount'OneOf1 | |
| PostCustomersCustomerRequestBodyBankAccount'Text Text |
Instances
data PostCustomersCustomerRequestBodyCard'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.card.anyOf in the specification.
Constructors
mkPostCustomersCustomerRequestBodyCard'OneOf1 Source #
Arguments
| :: Int | |
| -> Int | |
| -> Text | |
| -> PostCustomersCustomerRequestBodyCard'OneOf1 |
Create a new PostCustomersCustomerRequestBodyCard'OneOf1 with all required fields.
data PostCustomersCustomerRequestBodyCard'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.card.anyOf in the specification.
A token, like the ones returned by Stripe.js.
Constructors
| PostCustomersCustomerRequestBodyCard'PostCustomersCustomerRequestBodyCard'OneOf1 PostCustomersCustomerRequestBodyCard'OneOf1 | |
| PostCustomersCustomerRequestBodyCard'Text Text |
Instances
data PostCustomersCustomerRequestBodyInvoiceSettings' Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.invoice_settings in the specification.
Default invoice settings for this customer.
Constructors
| PostCustomersCustomerRequestBodyInvoiceSettings' | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBodyInvoiceSettings' :: PostCustomersCustomerRequestBodyInvoiceSettings' Source #
Create a new PostCustomersCustomerRequestBodyInvoiceSettings' with all required fields.
data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.invoice_settings.properties.custom_fields.anyOf.items in the specification.
Constructors
| PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 Source #
Arguments
Create a new PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 with all required fields.
data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.invoice_settings.properties.custom_fields.anyOf in the specification.
Constructors
Instances
data PostCustomersCustomerRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.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
| PostCustomersCustomerRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostCustomersCustomerRequestBodyMetadata'Object Object |
Instances
data PostCustomersCustomerRequestBodyShipping'OneOf1 Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping.anyOf in the specification.
Constructors
| PostCustomersCustomerRequestBodyShipping'OneOf1 | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBodyShipping'OneOf1 Source #
Arguments
| :: PostCustomersCustomerRequestBodyShipping'OneOf1Address' | |
| -> Text | |
| -> PostCustomersCustomerRequestBodyShipping'OneOf1 |
Create a new PostCustomersCustomerRequestBodyShipping'OneOf1 with all required fields.
data PostCustomersCustomerRequestBodyShipping'OneOf1Address' Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping.anyOf.properties.address in the specification.
Constructors
| PostCustomersCustomerRequestBodyShipping'OneOf1Address' | |
Fields
| |
Instances
mkPostCustomersCustomerRequestBodyShipping'OneOf1Address' Source #
Arguments
| :: Text |
|
| -> PostCustomersCustomerRequestBodyShipping'OneOf1Address' |
Create a new PostCustomersCustomerRequestBodyShipping'OneOf1Address' with all required fields.
data PostCustomersCustomerRequestBodyShipping'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.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
Instances
data PostCustomersCustomerRequestBodyTax' Source #
Defines the object schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax in the specification.
Tax details about the customer.
Constructors
| PostCustomersCustomerRequestBodyTax' | |
Instances
mkPostCustomersCustomerRequestBodyTax' :: PostCustomersCustomerRequestBodyTax' Source #
Create a new PostCustomersCustomerRequestBodyTax' with all required fields.
data PostCustomersCustomerRequestBodyTax'IpAddress'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax.properties.ip_address.anyOf in the specification.
Constructors
| PostCustomersCustomerRequestBodyTax'IpAddress'EmptyString | Represents the JSON value |
| PostCustomersCustomerRequestBodyTax'IpAddress'Text Text |
Instances
data PostCustomersCustomerRequestBodyTaxExempt' Source #
Defines the enum schema located at paths./v1/customers/{customer}.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
| PostCustomersCustomerRequestBodyTaxExempt'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostCustomersCustomerRequestBodyTaxExempt'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostCustomersCustomerRequestBodyTaxExempt'EnumEmptyString | Represents the JSON value |
| PostCustomersCustomerRequestBodyTaxExempt'EnumExempt | Represents the JSON value |
| PostCustomersCustomerRequestBodyTaxExempt'EnumNone | Represents the JSON value |
| PostCustomersCustomerRequestBodyTaxExempt'EnumReverse | Represents the JSON value |
data PostCustomersCustomerRequestBodyTrialEnd'Variants Source #
Defines the oneOf schema located at paths./v1/customers/{customer}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.trial_end.anyOf in the specification.
Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
Constructors
| PostCustomersCustomerRequestBodyTrialEnd'Now | Represents the JSON value |
| PostCustomersCustomerRequestBodyTrialEnd'Int Int |
Instances
data PostCustomersCustomerResponse Source #
Represents a response of the operation postCustomersCustomer.
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), PostCustomersCustomerResponseError is used.
Constructors
| PostCustomersCustomerResponseError String | Means either no matching case available or a parse error |
| PostCustomersCustomerResponse200 Customer | Successful response. |
| PostCustomersCustomerResponseDefault Error | Error response. |