Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.CustomerBalanceTransaction

Contains the types generated from the schema CustomerBalanceTransaction

5 types
1 value

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceCustomerBalanceTransaction.hs

datadata CustomerBalanceTransaction

Defines the object schema located at components.schemas.customer_balance_transaction in the specification.

Each customer has a `balance` value, which denotes a debit or credit that's automatically applied to their next invoice upon finalization. You may modify the value directly by using the update customer API, or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.

Related guide: Customer Balance to learn more.

Constructors

CustomerBalanceTransaction
- customerBalanceTransactionAmount :: Int
  amount: The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.
- customerBalanceTransactionCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- customerBalanceTransactionCreditNote :: Maybe (Nullable CustomerBalanceTransactionCreditNote'NonNullableVariants)
  credit_note: The ID of the credit note (if any) related to the transaction.
- customerBalanceTransactionCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customerBalanceTransactionCustomer :: CustomerBalanceTransactionCustomer'Variants
  customer: The ID of the customer the transaction belongs to.
- customerBalanceTransactionDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- customerBalanceTransactionEndingBalance :: Int
  ending_balance: The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
- customerBalanceTransactionId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- customerBalanceTransactionInvoice :: Maybe (Nullable CustomerBalanceTransactionInvoice'NonNullableVariants)
  invoice: The ID of the invoice (if any) related to the transaction.
- customerBalanceTransactionLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- customerBalanceTransactionMetadata :: Maybe (Nullable Object)
  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.
- customerBalanceTransactionType :: CustomerBalanceTransactionType'
  type: Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the Customer Balance page to learn more about transaction types.

Instances4Eq, Show, FromJSON, ToJSON

Eq CustomerBalanceTransactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
Show CustomerBalanceTransactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
FromJSON CustomerBalanceTransactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
ToJSON CustomerBalanceTransactionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction

valuemkCustomerBalanceTransaction

:: Int
customerBalanceTransactionAmount
-> Int
customerBalanceTransactionCreated
-> Text
customerBalanceTransactionCurrency
-> CustomerBalanceTransactionCustomer'Variants
customerBalanceTransactionCustomer
-> Int
customerBalanceTransactionEndingBalance
-> Text
customerBalanceTransactionId
-> Bool
customerBalanceTransactionLivemode
-> CustomerBalanceTransactionType'
customerBalanceTransactionType
-> CustomerBalanceTransaction

Create a new CustomerBalanceTransaction with all required fields.

datadata CustomerBalanceTransactionCreditNote'NonNullableVariants

Defines the oneOf schema located at components.schemas.customer_balance_transaction.properties.credit_note.anyOf in the specification.

The ID of the credit note (if any) related to the transaction.

Constructors

CustomerBalanceTransactionCreditNote'NonNullableText Text
CustomerBalanceTransactionCreditNote'NonNullableCreditNote CreditNote

Instances4Eq, Show, FromJSON, ToJSON

Eq CustomerBalanceTransactionCreditNote'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
Show CustomerBalanceTransactionCreditNote'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
FromJSON CustomerBalanceTransactionCreditNote'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
ToJSON CustomerBalanceTransactionCreditNote'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction

datadata CustomerBalanceTransactionCustomer'Variants

Defines the oneOf schema located at components.schemas.customer_balance_transaction.properties.customer.anyOf in the specification.

The ID of the customer the transaction belongs to.

Constructors

CustomerBalanceTransactionCustomer'Text Text
CustomerBalanceTransactionCustomer'Customer Customer

Instances4Eq, Show, FromJSON, ToJSON

Eq CustomerBalanceTransactionCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
Show CustomerBalanceTransactionCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
FromJSON CustomerBalanceTransactionCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
ToJSON CustomerBalanceTransactionCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction

datadata CustomerBalanceTransactionInvoice'NonNullableVariants

Defines the oneOf schema located at components.schemas.customer_balance_transaction.properties.invoice.anyOf in the specification.

The ID of the invoice (if any) related to the transaction.

Constructors

CustomerBalanceTransactionInvoice'NonNullableText Text
CustomerBalanceTransactionInvoice'NonNullableInvoice Invoice

Instances4Eq, Show, FromJSON, ToJSON

Eq CustomerBalanceTransactionInvoice'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
Show CustomerBalanceTransactionInvoice'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
FromJSON CustomerBalanceTransactionInvoice'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
ToJSON CustomerBalanceTransactionInvoice'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction

datadata CustomerBalanceTransactionType'

Defines the enum schema located at components.schemas.customer_balance_transaction.properties.type in the specification.

Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the Customer Balance page to learn more about transaction types.

Constructors

CustomerBalanceTransactionType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CustomerBalanceTransactionType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
CustomerBalanceTransactionType'EnumAdjustment
Represents the JSON value "adjustment"
CustomerBalanceTransactionType'EnumAppliedToInvoice
Represents the JSON value "applied_to_invoice"
CustomerBalanceTransactionType'EnumCreditNote
Represents the JSON value "credit_note"
CustomerBalanceTransactionType'EnumInitial
Represents the JSON value "initial"
CustomerBalanceTransactionType'EnumInvoiceTooLarge
Represents the JSON value "invoice_too_large"
CustomerBalanceTransactionType'EnumInvoiceTooSmall
Represents the JSON value "invoice_too_small"
CustomerBalanceTransactionType'EnumMigration
Represents the JSON value "migration"
CustomerBalanceTransactionType'EnumUnappliedFromInvoice
Represents the JSON value "unapplied_from_invoice"
CustomerBalanceTransactionType'EnumUnspentReceiverCredit
Represents the JSON value "unspent_receiver_credit"

Instances4Eq, Show, FromJSON, ToJSON

Eq CustomerBalanceTransactionType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
Show CustomerBalanceTransactionType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
FromJSON CustomerBalanceTransactionType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction
ToJSON CustomerBalanceTransactionType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.CustomerBalanceTransaction