CustomerBalanceTransaction class final
CustomerBalanceTransaction
Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-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](https://stripe.com/docs/api/customers/update), or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`. Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)
- Implemented types
Constructors
-
CustomerBalanceTransaction({required int amount, required DateTime created, CreditNoteOrId? creditNote, required String currency, required CustomerOrId customer, String? description, required int endingBalance, required String id, InvoiceOrId? invoice, required bool livemode, Map<
String, String> ? metadata, required CustomerBalanceTransactionType type}) -
CustomerBalanceTransaction
const
- CustomerBalanceTransaction.fromJson(Object? json)
-
factory
Properties
- amount → int
-
final
- created → DateTime
-
final
- creditNote → CreditNoteOrId?
-
final
- currency → String
-
final
- customer → CustomerOrId
-
final
- description → String?
-
final
- endingBalance → int
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The ID of the CustomerBalanceTransaction.
final
- invoice → InvoiceOrId?
-
final
- livemode → bool
-
final
-
metadata
→ Map<
String, String> ? -
final
- object → String
-
The resource's type.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → CustomerBalanceTransactionType
-
final
Methods
-
encodeWith<
V> (Encoder< V> encoder) → V -
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
encode<
V> (CustomerBalanceTransaction instance, Encoder< V> encoder) → V -
override