| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCustomersCustomer
Description
Contains the different functions to run the operation postCustomersCustomer
Synopsis
- postCustomersCustomer :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCustomersCustomerRequestBody -> m (Either HttpException (Response PostCustomersCustomerResponse))
- postCustomersCustomerRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCustomersCustomerRequestBody -> m (Either HttpException (Response ByteString))
- postCustomersCustomerM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCustomersCustomerRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersCustomerResponse))
- postCustomersCustomerRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCustomersCustomerRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostCustomersCustomerRequestBody = PostCustomersCustomerRequestBody {
- postCustomersCustomerRequestBodyAddress :: Maybe PostCustomersCustomerRequestBodyAddress'Variants
- postCustomersCustomerRequestBodyBalance :: Maybe Integer
- 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'
- postCustomersCustomerRequestBodyName :: Maybe Text
- postCustomersCustomerRequestBodyNextInvoiceSequence :: Maybe Integer
- postCustomersCustomerRequestBodyPhone :: Maybe Text
- postCustomersCustomerRequestBodyPreferredLocales :: Maybe ([] Text)
- postCustomersCustomerRequestBodyShipping :: Maybe PostCustomersCustomerRequestBodyShipping'Variants
- postCustomersCustomerRequestBodySource :: Maybe Text
- postCustomersCustomerRequestBodyTaxExempt :: Maybe PostCustomersCustomerRequestBodyTaxExempt'
- postCustomersCustomerRequestBodyTrialEnd :: Maybe PostCustomersCustomerRequestBodyTrialEnd'Variants
- data PostCustomersCustomerRequestBodyAddress'OneOf1
- data PostCustomersCustomerRequestBodyAddress'OneOf2 = PostCustomersCustomerRequestBodyAddress'OneOf2 {
- postCustomersCustomerRequestBodyAddress'OneOf2City :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf2Country :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf2Line1 :: Text
- postCustomersCustomerRequestBodyAddress'OneOf2Line2 :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf2PostalCode :: Maybe Text
- postCustomersCustomerRequestBodyAddress'OneOf2State :: Maybe Text
- data PostCustomersCustomerRequestBodyAddress'Variants
- data PostCustomersCustomerRequestBodyBankAccount'OneOf2 = PostCustomersCustomerRequestBodyBankAccount'OneOf2 {
- postCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderName :: Maybe Text
- postCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType :: Maybe PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType'
- postCustomersCustomerRequestBodyBankAccount'OneOf2AccountNumber :: Text
- postCustomersCustomerRequestBodyBankAccount'OneOf2Country :: Text
- postCustomersCustomerRequestBodyBankAccount'OneOf2Currency :: Maybe Text
- postCustomersCustomerRequestBodyBankAccount'OneOf2Object :: Maybe PostCustomersCustomerRequestBodyBankAccount'OneOf2Object'
- postCustomersCustomerRequestBodyBankAccount'OneOf2RoutingNumber :: Maybe Text
- data PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType'
- = PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType'EnumOther Value
- | PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType'EnumTyped Text
- | PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType'EnumStringCompany
- | PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType'EnumStringIndividual
- data PostCustomersCustomerRequestBodyBankAccount'OneOf2Object'
- data PostCustomersCustomerRequestBodyBankAccount'Variants
- data PostCustomersCustomerRequestBodyCard'OneOf2 = PostCustomersCustomerRequestBodyCard'OneOf2 {
- postCustomersCustomerRequestBodyCard'OneOf2AddressCity :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2AddressCountry :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2AddressLine1 :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2AddressLine2 :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2AddressState :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2AddressZip :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2Cvc :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2ExpMonth :: Integer
- postCustomersCustomerRequestBodyCard'OneOf2ExpYear :: Integer
- postCustomersCustomerRequestBodyCard'OneOf2Metadata :: Maybe PostCustomersCustomerRequestBodyCard'OneOf2Metadata'
- postCustomersCustomerRequestBodyCard'OneOf2Name :: Maybe Text
- postCustomersCustomerRequestBodyCard'OneOf2Number :: Text
- postCustomersCustomerRequestBodyCard'OneOf2Object :: Maybe PostCustomersCustomerRequestBodyCard'OneOf2Object'
- data PostCustomersCustomerRequestBodyCard'OneOf2Metadata' = PostCustomersCustomerRequestBodyCard'OneOf2Metadata' {
- data PostCustomersCustomerRequestBodyCard'OneOf2Object'
- data PostCustomersCustomerRequestBodyCard'Variants
- data PostCustomersCustomerRequestBodyInvoiceSettings' = PostCustomersCustomerRequestBodyInvoiceSettings' {}
- data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1
- data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf2 = PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf2 {}
- data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'Variants
- = PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1
- | PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'ListPostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf2 ([] PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf2)
- data PostCustomersCustomerRequestBodyMetadata' = PostCustomersCustomerRequestBodyMetadata' {
- data PostCustomersCustomerRequestBodyShipping'OneOf1
- data PostCustomersCustomerRequestBodyShipping'OneOf2 = PostCustomersCustomerRequestBodyShipping'OneOf2 {}
- data PostCustomersCustomerRequestBodyShipping'OneOf2Address' = PostCustomersCustomerRequestBodyShipping'OneOf2Address' {
- postCustomersCustomerRequestBodyShipping'OneOf2Address'City :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf2Address'Country :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf2Address'Line1 :: Text
- postCustomersCustomerRequestBodyShipping'OneOf2Address'Line2 :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf2Address'PostalCode :: Maybe Text
- postCustomersCustomerRequestBodyShipping'OneOf2Address'State :: Maybe Text
- data PostCustomersCustomerRequestBodyShipping'Variants
- data PostCustomersCustomerRequestBodyTaxExempt'
- = PostCustomersCustomerRequestBodyTaxExempt'EnumOther Value
- | PostCustomersCustomerRequestBodyTaxExempt'EnumTyped Text
- | PostCustomersCustomerRequestBodyTaxExempt'EnumString_
- | PostCustomersCustomerRequestBodyTaxExempt'EnumStringExempt
- | PostCustomersCustomerRequestBodyTaxExempt'EnumStringNone
- | PostCustomersCustomerRequestBodyTaxExempt'EnumStringReverse
- data PostCustomersCustomerRequestBodyTrialEnd'OneOf1
- data PostCustomersCustomerRequestBodyTrialEnd'Variants
- data PostCustomersCustomerResponse
Documentation
postCustomersCustomer Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | customer | Constraints: Maximum length of 5000 |
| -> Maybe PostCustomersCustomerRequestBody | The request body to send |
| -> m (Either HttpException (Response PostCustomersCustomerResponse)) | Monad containing 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>
postCustomersCustomerRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCustomersCustomerRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/customers/{customer}The same as postCustomersCustomer but returns the raw ByteString
postCustomersCustomerM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCustomersCustomerRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersCustomerResponse)) Source #
POST /v1/customers/{customer}Monadic version of postCustomersCustomer (use with runWithConfiguration)
postCustomersCustomerRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCustomersCustomerRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/customers/{customer}Monadic version of postCustomersCustomerRaw (use with runWithConfiguration)
data PostCustomersCustomerRequestBody Source #
Defines the data type for the schema postCustomersCustomerRequestBody
Constructors
| PostCustomersCustomerRequestBody | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyAddress'OneOf1 Source #
Defines the enum schema postCustomersCustomerRequestBodyAddress'OneOf1
Constructors
| PostCustomersCustomerRequestBodyAddress'OneOf1EnumOther Value | |
| PostCustomersCustomerRequestBodyAddress'OneOf1EnumTyped Text | |
| PostCustomersCustomerRequestBodyAddress'OneOf1EnumString_ |
Instances
data PostCustomersCustomerRequestBodyAddress'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerRequestBodyAddress'OneOf2
Constructors
| PostCustomersCustomerRequestBodyAddress'OneOf2 | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyAddress'Variants Source #
Define the one-of schema postCustomersCustomerRequestBodyAddress'
The customer's address.
Constructors
Instances
data PostCustomersCustomerRequestBodyBankAccount'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerRequestBodyBank_account'OneOf2
Constructors
| PostCustomersCustomerRequestBodyBankAccount'OneOf2 | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyBankAccount'OneOf2AccountHolderType' Source #
Defines the enum schema postCustomersCustomerRequestBodyBank_account'OneOf2Account_holder_type'
Constructors
Instances
data PostCustomersCustomerRequestBodyBankAccount'OneOf2Object' Source #
Defines the enum schema postCustomersCustomerRequestBodyBank_account'OneOf2Object'
Constructors
Instances
data PostCustomersCustomerRequestBodyBankAccount'Variants Source #
Define the one-of schema postCustomersCustomerRequestBodyBank_account'
Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
Constructors
| PostCustomersCustomerRequestBodyBankAccount'Text Text | |
| PostCustomersCustomerRequestBodyBankAccount'PostCustomersCustomerRequestBodyBankAccount'OneOf2 PostCustomersCustomerRequestBodyBankAccount'OneOf2 |
Instances
data PostCustomersCustomerRequestBodyCard'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerRequestBodyCard'OneOf2
Constructors
data PostCustomersCustomerRequestBodyCard'OneOf2Metadata' Source #
Defines the data type for the schema postCustomersCustomerRequestBodyCard'OneOf2Metadata'
Instances
data PostCustomersCustomerRequestBodyCard'OneOf2Object' Source #
Defines the enum schema postCustomersCustomerRequestBodyCard'OneOf2Object'
Constructors
| PostCustomersCustomerRequestBodyCard'OneOf2Object'EnumOther Value | |
| PostCustomersCustomerRequestBodyCard'OneOf2Object'EnumTyped Text | |
| PostCustomersCustomerRequestBodyCard'OneOf2Object'EnumStringCard |
Instances
data PostCustomersCustomerRequestBodyCard'Variants Source #
Define the one-of schema postCustomersCustomerRequestBodyCard'
A token, like the ones returned by Stripe.js.
Constructors
| PostCustomersCustomerRequestBodyCard'Text Text | |
| PostCustomersCustomerRequestBodyCard'PostCustomersCustomerRequestBodyCard'OneOf2 PostCustomersCustomerRequestBodyCard'OneOf2 |
Instances
data PostCustomersCustomerRequestBodyInvoiceSettings' Source #
Defines the data type for the schema postCustomersCustomerRequestBodyInvoice_settings'
Default invoice settings for this customer.
Constructors
| PostCustomersCustomerRequestBodyInvoiceSettings' | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf1 Source #
Defines the enum schema postCustomersCustomerRequestBodyInvoice_settings'Custom_fields'OneOf1
Constructors
Instances
data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerRequestBodyInvoice_settings'Custom_fields'OneOf2
Constructors
| PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'OneOf2 | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyInvoiceSettings'CustomFields'Variants Source #
Define the one-of schema postCustomersCustomerRequestBodyInvoice_settings'Custom_fields'
Constructors
Instances
data PostCustomersCustomerRequestBodyMetadata' Source #
Defines the data type for the schema postCustomersCustomerRequestBodyMetadata'
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' | |
Instances
data PostCustomersCustomerRequestBodyShipping'OneOf1 Source #
Defines the enum schema postCustomersCustomerRequestBodyShipping'OneOf1
Constructors
| PostCustomersCustomerRequestBodyShipping'OneOf1EnumOther Value | |
| PostCustomersCustomerRequestBodyShipping'OneOf1EnumTyped Text | |
| PostCustomersCustomerRequestBodyShipping'OneOf1EnumString_ |
Instances
data PostCustomersCustomerRequestBodyShipping'OneOf2 Source #
Defines the data type for the schema postCustomersCustomerRequestBodyShipping'OneOf2
Constructors
| PostCustomersCustomerRequestBodyShipping'OneOf2 | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyShipping'OneOf2Address' Source #
Defines the data type for the schema postCustomersCustomerRequestBodyShipping'OneOf2Address'
Constructors
| PostCustomersCustomerRequestBodyShipping'OneOf2Address' | |
Fields
| |
Instances
data PostCustomersCustomerRequestBodyShipping'Variants Source #
Define the one-of schema postCustomersCustomerRequestBodyShipping'
The customer's shipping information. Appears on invoices emailed to this customer.
Constructors
Instances
data PostCustomersCustomerRequestBodyTaxExempt' Source #
Defines the enum schema postCustomersCustomerRequestBodyTax_exempt'
The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
Constructors
data PostCustomersCustomerRequestBodyTrialEnd'OneOf1 Source #
Defines the enum schema postCustomersCustomerRequestBodyTrial_end'OneOf1
Constructors
| PostCustomersCustomerRequestBodyTrialEnd'OneOf1EnumOther Value | |
| PostCustomersCustomerRequestBodyTrialEnd'OneOf1EnumTyped Text | |
| PostCustomersCustomerRequestBodyTrialEnd'OneOf1EnumStringNow |
Instances
data PostCustomersCustomerRequestBodyTrialEnd'Variants Source #
Define the one-of schema postCustomersCustomerRequestBodyTrial_end'
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'PostCustomersCustomerRequestBodyTrialEnd'OneOf1 PostCustomersCustomerRequestBodyTrialEnd'OneOf1 | |
| PostCustomersCustomerRequestBodyTrialEnd'Integer Integer |
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. |