StripeAPI.Types.CustomerBalanceTransaction

Contains the types generated from the schema CustomerBalanceTransaction

Documentation

data 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

Fields

• 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 CustomerBalanceTransactionCreditNote'Variants

  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 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 CustomerBalanceTransactionInvoice'Variants

  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 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.

Instances

Eq CustomerBalanceTransaction

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

(==) :: CustomerBalanceTransaction -> CustomerBalanceTransaction -> Bool

(/=) :: CustomerBalanceTransaction -> CustomerBalanceTransaction -> Bool

Show CustomerBalanceTransaction

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

showsPrec :: Int -> CustomerBalanceTransaction -> ShowS

show :: CustomerBalanceTransaction -> String

showList :: [CustomerBalanceTransaction] -> ShowS

ToJSON CustomerBalanceTransaction

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

toJSON :: CustomerBalanceTransaction -> Value

toEncoding :: CustomerBalanceTransaction -> Encoding

toJSONList :: [CustomerBalanceTransaction] -> Value

toEncodingList :: [CustomerBalanceTransaction] -> Encoding

FromJSON CustomerBalanceTransaction

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

parseJSON :: Value -> Parser CustomerBalanceTransaction

parseJSONList :: Value -> Parser [CustomerBalanceTransaction]

mkCustomerBalanceTransaction

Arguments

:: 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.

data CustomerBalanceTransactionCreditNote'Variants

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'Text Text

CustomerBalanceTransactionCreditNote'CreditNote CreditNote

Instances

Eq CustomerBalanceTransactionCreditNote'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

(==) :: CustomerBalanceTransactionCreditNote'Variants -> CustomerBalanceTransactionCreditNote'Variants -> Bool

(/=) :: CustomerBalanceTransactionCreditNote'Variants -> CustomerBalanceTransactionCreditNote'Variants -> Bool

Show CustomerBalanceTransactionCreditNote'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

showsPrec :: Int -> CustomerBalanceTransactionCreditNote'Variants -> ShowS

show :: CustomerBalanceTransactionCreditNote'Variants -> String

showList :: [CustomerBalanceTransactionCreditNote'Variants] -> ShowS

ToJSON CustomerBalanceTransactionCreditNote'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

toJSON :: CustomerBalanceTransactionCreditNote'Variants -> Value

toEncoding :: CustomerBalanceTransactionCreditNote'Variants -> Encoding

toJSONList :: [CustomerBalanceTransactionCreditNote'Variants] -> Value

toEncodingList :: [CustomerBalanceTransactionCreditNote'Variants] -> Encoding

FromJSON CustomerBalanceTransactionCreditNote'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

parseJSON :: Value -> Parser CustomerBalanceTransactionCreditNote'Variants

parseJSONList :: Value -> Parser [CustomerBalanceTransactionCreditNote'Variants]

data 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

Instances

Eq CustomerBalanceTransactionCustomer'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

(==) :: CustomerBalanceTransactionCustomer'Variants -> CustomerBalanceTransactionCustomer'Variants -> Bool

(/=) :: CustomerBalanceTransactionCustomer'Variants -> CustomerBalanceTransactionCustomer'Variants -> Bool

Show CustomerBalanceTransactionCustomer'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

showsPrec :: Int -> CustomerBalanceTransactionCustomer'Variants -> ShowS

show :: CustomerBalanceTransactionCustomer'Variants -> String

showList :: [CustomerBalanceTransactionCustomer'Variants] -> ShowS

ToJSON CustomerBalanceTransactionCustomer'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

toJSON :: CustomerBalanceTransactionCustomer'Variants -> Value

toEncoding :: CustomerBalanceTransactionCustomer'Variants -> Encoding

toJSONList :: [CustomerBalanceTransactionCustomer'Variants] -> Value

toEncodingList :: [CustomerBalanceTransactionCustomer'Variants] -> Encoding

FromJSON CustomerBalanceTransactionCustomer'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

parseJSON :: Value -> Parser CustomerBalanceTransactionCustomer'Variants

parseJSONList :: Value -> Parser [CustomerBalanceTransactionCustomer'Variants]

data CustomerBalanceTransactionInvoice'Variants

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'Text Text

CustomerBalanceTransactionInvoice'Invoice Invoice

Instances

Eq CustomerBalanceTransactionInvoice'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

(==) :: CustomerBalanceTransactionInvoice'Variants -> CustomerBalanceTransactionInvoice'Variants -> Bool

(/=) :: CustomerBalanceTransactionInvoice'Variants -> CustomerBalanceTransactionInvoice'Variants -> Bool

Show CustomerBalanceTransactionInvoice'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

showsPrec :: Int -> CustomerBalanceTransactionInvoice'Variants -> ShowS

show :: CustomerBalanceTransactionInvoice'Variants -> String

showList :: [CustomerBalanceTransactionInvoice'Variants] -> ShowS

ToJSON CustomerBalanceTransactionInvoice'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

toJSON :: CustomerBalanceTransactionInvoice'Variants -> Value

toEncoding :: CustomerBalanceTransactionInvoice'Variants -> Encoding

toJSONList :: [CustomerBalanceTransactionInvoice'Variants] -> Value

toEncodingList :: [CustomerBalanceTransactionInvoice'Variants] -> Encoding

FromJSON CustomerBalanceTransactionInvoice'Variants

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

parseJSON :: Value -> Parser CustomerBalanceTransactionInvoice'Variants

parseJSONList :: Value -> Parser [CustomerBalanceTransactionInvoice'Variants]

data 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"

Instances

Eq CustomerBalanceTransactionType'

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

(==) :: CustomerBalanceTransactionType' -> CustomerBalanceTransactionType' -> Bool

(/=) :: CustomerBalanceTransactionType' -> CustomerBalanceTransactionType' -> Bool

Show CustomerBalanceTransactionType'

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

showsPrec :: Int -> CustomerBalanceTransactionType' -> ShowS

show :: CustomerBalanceTransactionType' -> String

showList :: [CustomerBalanceTransactionType'] -> ShowS

ToJSON CustomerBalanceTransactionType'

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

toJSON :: CustomerBalanceTransactionType' -> Value

toEncoding :: CustomerBalanceTransactionType' -> Encoding

toJSONList :: [CustomerBalanceTransactionType'] -> Value

toEncodingList :: [CustomerBalanceTransactionType'] -> Encoding

FromJSON CustomerBalanceTransactionType'

Defined in StripeAPI.Types.CustomerBalanceTransaction

Methods

parseJSON :: Value -> Parser CustomerBalanceTransactionType'

parseJSONList :: Value -> Parser [CustomerBalanceTransactionType']