Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

Contains the different functions to run the operation postCustomersCustomerBalanceTransactions

3 types
2 values

Packagestripeapi-3.0.0.0
Exports5
LanguageHaskell2010
LicenceMIT
SourcePostCustomersCustomerBalanceTransactions.hs

valuepostCustomersCustomerBalanceTransactions

:: MonadHTTP m
=> Text
customer | Constraints: Maximum length of 5000
-> PostCustomersCustomerBalanceTransactionsRequestBody
The request body to send
-> ClientT m (Response PostCustomersCustomerBalanceTransactionsResponse)
Monadic computation which returns the result of the operation

POST /v1/customers/{customer}/balance_transactions

<p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>

datadata PostCustomersCustomerBalanceTransactionsRequestBody

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

Constructors

PostCustomersCustomerBalanceTransactionsRequestBody
- postCustomersCustomerBalanceTransactionsRequestBodyAmount :: Int
  amount: The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.
- postCustomersCustomerBalanceTransactionsRequestBodyCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency. If the customer's `currency` is set, this value must match it. If the customer's `currency` is not set, it will be updated to this value.
- postCustomersCustomerBalanceTransactionsRequestBodyDescription :: Maybe Text
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 350
- postCustomersCustomerBalanceTransactionsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postCustomersCustomerBalanceTransactionsRequestBodyMetadata :: Maybe PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'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`.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersCustomerBalanceTransactionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
Show PostCustomersCustomerBalanceTransactionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
FromJSON PostCustomersCustomerBalanceTransactionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
ToJSON PostCustomersCustomerBalanceTransactionsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

valuemkPostCustomersCustomerBalanceTransactionsRequestBody

:: Int
postCustomersCustomerBalanceTransactionsRequestBodyAmount
-> Text
postCustomersCustomerBalanceTransactionsRequestBodyCurrency
-> PostCustomersCustomerBalanceTransactionsRequestBody

Create a new PostCustomersCustomerBalanceTransactionsRequestBody with all required fields.

datadata PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/customers/{customer}/balance_transactions.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

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
Show PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
FromJSON PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
ToJSON PostCustomersCustomerBalanceTransactionsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions

datadata PostCustomersCustomerBalanceTransactionsResponse

Represents a response of the operation postCustomersCustomerBalanceTransactions.

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

Constructors

PostCustomersCustomerBalanceTransactionsResponseError String
Means either no matching case available or a parse error
PostCustomersCustomerBalanceTransactionsResponse200 CustomerBalanceTransaction
Successful response.
PostCustomersCustomerBalanceTransactionsResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostCustomersCustomerBalanceTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions
Show PostCustomersCustomerBalanceTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCustomersCustomerBalanceTransactions