stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.CustomerBalanceTransaction

Description

Contains the types generated from the schema CustomerBalanceTransaction

Synopsis

Documentation

data CustomerBalanceTransaction Source #

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 

Fields

data CustomerBalanceTransactionCreditNote'Variants Source #

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.

data CustomerBalanceTransactionCustomer'Variants Source #

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.

data CustomerBalanceTransactionInvoice'Variants Source #

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.

data CustomerBalanceTransactionType' Source #

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"