Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. CustomerBalanceTransaction
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.CustomerBalanceTransaction

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    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

    Create CustomerBalanceTransaction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomerBalanceTransaction(name: string, args: CustomerBalanceTransactionArgs, opts?: CustomResourceOptions);
    @overload
def CustomerBalanceTransaction(resource_name: str,
                               args: CustomerBalanceTransactionArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def CustomerBalanceTransaction(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               amount: Optional[float] = None,
                               currency: Optional[str] = None,
                               customer: Optional[str] = None,
                               description: Optional[str] = None,
                               metadata: Optional[Mapping[str, str]] = None)
    func NewCustomerBalanceTransaction(ctx *Context, name string, args CustomerBalanceTransactionArgs, opts ...ResourceOption) (*CustomerBalanceTransaction, error)
    public CustomerBalanceTransaction(string name, CustomerBalanceTransactionArgs args, CustomResourceOptions? opts = null)
    public CustomerBalanceTransaction(String name, CustomerBalanceTransactionArgs args)
public CustomerBalanceTransaction(String name, CustomerBalanceTransactionArgs args, CustomResourceOptions options)

    type: stripe:CustomerBalanceTransaction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_customer_balance_transaction" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CustomerBalanceTransactionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomerBalanceTransactionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomerBalanceTransactionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomerBalanceTransactionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomerBalanceTransactionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var customerBalanceTransactionResource = new Stripe.CustomerBalanceTransaction("customerBalanceTransactionResource", new()
{
    Amount = 0.0,
    Currency = "string",
    Customer = "string",
    Description = "string",
    Metadata = 
    {
        { "string", "string" },
    },
});

    example, err := stripe.NewCustomerBalanceTransaction(ctx, "customerBalanceTransactionResource", &stripe.CustomerBalanceTransactionArgs{
	Amount:      pulumi.Float64(0),
	Currency:    pulumi.String("string"),
	Customer:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    resource "stripe_customer_balance_transaction" "customerBalanceTransactionResource" {
  lifecycle {
    create_before_destroy = true
  }
  amount      = 0
  currency    = "string"
  customer    = "string"
  description = "string"
  metadata = {
    "string" = "string"
  }
}

    var customerBalanceTransactionResource = new CustomerBalanceTransaction("customerBalanceTransactionResource", CustomerBalanceTransactionArgs.builder()
    .amount(0.0)
    .currency("string")
    .customer("string")
    .description("string")
    .metadata(Map.of("string", "string"))
    .build());

    customer_balance_transaction_resource = stripe.CustomerBalanceTransaction("customerBalanceTransactionResource",
    amount=float(0),
    currency="string",
    customer="string",
    description="string",
    metadata={
        "string": "string",
    })

    const customerBalanceTransactionResource = new stripe.CustomerBalanceTransaction("customerBalanceTransactionResource", {
    amount: 0,
    currency: "string",
    customer: "string",
    description: "string",
    metadata: {
        string: "string",
    },
});

    type: stripe:CustomerBalanceTransaction
properties:
    amount: 0
    currency: string
    customer: string
    description: string
    metadata:
        string: string

    CustomerBalanceTransaction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomerBalanceTransaction resource accepts the following input properties:

    Amount double
    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.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer the transaction belongs to.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Metadata Dictionary<string, string>
    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.
    Amount float64
    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.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer the transaction belongs to.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Metadata map[string]string
    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.
    amount number
    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.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer the transaction belongs to.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata map(string)
    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.
    amount Double
    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.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer the transaction belongs to.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata Map<String,String>
    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.
    amount number
    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.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer the transaction belongs to.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata {[key: string]: string}
    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.
    amount float
    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.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    The ID of the customer the transaction belongs to.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata Mapping[str, str]
    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.
    amount Number
    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.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer the transaction belongs to.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    metadata Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomerBalanceTransaction resource produces the following output properties:

    CheckoutSession string
    The ID of the checkout session (if any) that created the transaction.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CreditNote string
    The ID of the credit note (if any) related to the transaction.
    EndingBalance double
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Invoice string
    The ID of the invoice (if any) related to the transaction.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    CheckoutSession string
    The ID of the checkout session (if any) that created the transaction.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CreditNote string
    The ID of the credit note (if any) related to the transaction.
    EndingBalance float64
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Invoice string
    The ID of the invoice (if any) related to the transaction.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    checkout_session string
    The ID of the checkout session (if any) that created the transaction.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    credit_note string
    The ID of the credit note (if any) related to the transaction.
    ending_balance number
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    invoice string
    The ID of the invoice (if any) related to the transaction.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    checkoutSession String
    The ID of the checkout session (if any) that created the transaction.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditNote String
    The ID of the credit note (if any) related to the transaction.
    endingBalance Double
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    invoice String
    The ID of the invoice (if any) related to the transaction.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    type String
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    checkoutSession string
    The ID of the checkout session (if any) that created the transaction.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditNote string
    The ID of the credit note (if any) related to the transaction.
    endingBalance number
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    invoice string
    The ID of the invoice (if any) related to the transaction.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    checkout_session str
    The ID of the checkout session (if any) that created the transaction.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    credit_note str
    The ID of the credit note (if any) related to the transaction.
    ending_balance float
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    invoice str
    The ID of the invoice (if any) related to the transaction.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    type str
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    checkoutSession String
    The ID of the checkout session (if any) that created the transaction.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditNote String
    The ID of the credit note (if any) related to the transaction.
    endingBalance Number
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    invoice String
    The ID of the invoice (if any) related to the transaction.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    type String
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.

    Look up Existing CustomerBalanceTransaction Resource

    Get an existing CustomerBalanceTransaction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CustomerBalanceTransactionState, opts?: CustomResourceOptions): CustomerBalanceTransaction
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[float] = None,
        checkout_session: Optional[str] = None,
        created: Optional[float] = None,
        credit_note: Optional[str] = None,
        currency: Optional[str] = None,
        customer: Optional[str] = None,
        description: Optional[str] = None,
        ending_balance: Optional[float] = None,
        invoice: Optional[str] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        type: Optional[str] = None) -> CustomerBalanceTransaction
    func GetCustomerBalanceTransaction(ctx *Context, name string, id IDInput, state *CustomerBalanceTransactionState, opts ...ResourceOption) (*CustomerBalanceTransaction, error)
    public static CustomerBalanceTransaction Get(string name, Input<string> id, CustomerBalanceTransactionState? state, CustomResourceOptions? opts = null)
    public static CustomerBalanceTransaction get(String name, Output<String> id, CustomerBalanceTransactionState state, CustomResourceOptions options)
    resources:  _:    type: stripe:CustomerBalanceTransaction    get:      id: ${id}
    import {
  to = stripe_customer_balance_transaction.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Amount double
    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.
    CheckoutSession string
    The ID of the checkout session (if any) that created the transaction.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CreditNote string
    The ID of the credit note (if any) related to the transaction.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer the transaction belongs to.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    EndingBalance double
    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.
    Invoice string
    The ID of the invoice (if any) related to the transaction.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata Dictionary<string, string>
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    Amount float64
    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.
    CheckoutSession string
    The ID of the checkout session (if any) that created the transaction.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CreditNote string
    The ID of the credit note (if any) related to the transaction.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer the transaction belongs to.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    EndingBalance float64
    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.
    Invoice string
    The ID of the invoice (if any) related to the transaction.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata map[string]string
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    amount number
    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.
    checkout_session string
    The ID of the checkout session (if any) that created the transaction.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    credit_note string
    The ID of the credit note (if any) related to the transaction.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer the transaction belongs to.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    ending_balance number
    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.
    invoice string
    The ID of the invoice (if any) related to the transaction.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata map(string)
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    amount Double
    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.
    checkoutSession String
    The ID of the checkout session (if any) that created the transaction.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditNote String
    The ID of the credit note (if any) related to the transaction.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer the transaction belongs to.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    endingBalance Double
    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.
    invoice String
    The ID of the invoice (if any) related to the transaction.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String,String>
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    type String
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    amount number
    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.
    checkoutSession string
    The ID of the checkout session (if any) that created the transaction.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditNote string
    The ID of the credit note (if any) related to the transaction.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer the transaction belongs to.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    endingBalance number
    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.
    invoice string
    The ID of the invoice (if any) related to the transaction.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata {[key: string]: string}
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    type string
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    amount float
    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.
    checkout_session str
    The ID of the checkout session (if any) that created the transaction.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    credit_note str
    The ID of the credit note (if any) related to the transaction.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    The ID of the customer the transaction belongs to.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    ending_balance float
    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.
    invoice str
    The ID of the invoice (if any) related to the transaction.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Mapping[str, str]
    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.
    object str
    String representing the object's type. Objects of the same type share the same value.
    type str
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
    amount Number
    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.
    checkoutSession String
    The ID of the checkout session (if any) that created the transaction.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditNote String
    The ID of the credit note (if any) related to the transaction.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer the transaction belongs to.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    endingBalance Number
    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.
    invoice String
    The ID of the invoice (if any) related to the transaction.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String>
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    type String
    Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial