provider POST /v1/customers/{customer}/balance_transactions
@utdk/stripe /v1/customers/{customer}/balance_transactions
Create a customer balance transaction
<p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>
customer path required
string

Try it

Authentication
Configure credentials for Stripe API
postcustomerscustomerbalancetransactions
POST/v1/customers/{customer}/balance_transactions
<p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>

Parameters

required

Input

required

The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.

required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.

An arbitrary string attached to the object. Often useful for displaying to users.

Specifies which fields in the response should be expanded.

Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postcustomerscustomerbalancetransactions()