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_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - 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_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
Returns a list of credit balance transactions.
{ "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"}