List credit balance transactions 

Billing
Credit Balance Transaction
List credit balance transactions

Retrieve a list of credit balance transactions.

Parameters

  • customerstringRequired

    The customer for which to fetch credit balance transactions.

  • credit_grantstring

    The credit grant for which to fetch credit balance transactions.

More parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

Returns a list of credit balance transactions.

GET /v1/billing/credit_balance_transactions
curl -G https://api.stripe.com/v1/billing/credit_balance_transactions \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d customer=cus_QrvQguzkIK8zTj \
-d credit_grant=credgr_test_61R9ZkIkIzLSp0xze41L6nFOS1ekDTPE
Response
{
"object": "list",
"data": [
{
"id": "cbtxn_test_61R9ZljjaFmdidb6e41L6nFOS1ekD9Ue",
"object": "billing.credit_balance_transaction",
"created": 1726619524,
"credit": null,
"credit_grant": "credgr_test_61R9ZkIkIzLSp0xze41L6nFOS1ekDTPE",
"debit": {
"amount": {
"monetary": {
"currency": "usd",
"value": 1000
},
"type": "monetary"
},
"credits_applied": {
"invoice": "in_1Q0BoLL6nFOS1ekDbwBM5ER1",
"invoice_line_item": "il_1QB443L6nFOS1ekDwRiN3Z4n"
},
"type": "credits_applied"
},
"effective_at": 1729211351,
"livemode": false,
"test_clock": "clock_1Q0BoJL6nFOS1ekDbyYYuseM",
"type": "debit"
},
{
"id": "cbtxn_test_61R9ZkIbb17ze4b2s41L6nFOS1ekDXHs",
"object": "billing.credit_balance_transaction",
"created": 1726619434,
"credit": {
"amount": {
"monetary": {
"currency": "usd",
"value": 1000
},
"type": "monetary"
},
"type": "credits_granted"
},
"credit_grant": "credgr_test_61R9ZkIkIzLSp0xze41L6nFOS1ekDTPE",
"debit": null,
"effective_at": 1726619434,
"livemode": false,
"test_clock": "clock_1Q0BoJL6nFOS1ekDbyYYuseM",
"type": "credit"
}
],
"has_more": false,
"url": "/v1/billing/credit_grants"
}