Sample - Stripe API
GET/v1/billing/credit_balance_transactions/{id}

Get a credit balance transaction

Retrieves a specific credit balance transaction associated with a credit grant. Provide the transaction id and optionally request expanded response fields with expand. The returned transaction identifies whether the recorded activity is a credit or debit when that information is present.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the credit balance transaction.
expandarray<string>optional
Specifies which response fields to expand.

2 status codes
200Returns the credit balance transaction with its creation time, effective time, associated credit grant, identifier, livemode, object type, and available credit or debit details.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
creditobjectoptional
Credit details for this credit balance transaction. Only present if type is `credit`.
credit_grantstringrequired
The credit grant associated with this credit balance transaction.
debitobjectoptional
Debit details for this credit balance transaction. Only present if type is `debit`.
effective_atintegerrequired
The effective time of this credit balance transaction.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:billing.credit_balance_transaction
test_clockstringoptional
ID of the test clock this credit balance transaction belongs to.
typestringoptional
The type of credit balance transaction (credit or debit).
Allowed:creditdebit
defaultError response.
errorobjectrequired

Error handling

id must identify the credit balance transaction to retrieve and must not exceed 5000 characters. Each value in expand must be a string of no more than 5000 characters.