Credit Balance Transactions

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Was this section helpful?Yes No

Retrieve a credit balance transaction

GET/v1/billing/credit_balance_transactions/:id

List credit balance transactions

GET/v1/billing/credit_balance_transactions

The Credit Balance Transaction object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

creditnullable object
Credit details for this credit balance transaction. Only present if type is credit.

credit_grantstringExpandable
The credit grant associated with this credit balance transaction.

debitnullable object
Debit details for this credit balance transaction. Only present if type is debit.

effective_attimestamp
The effective time of this credit balance transaction.

livemodeboolean
If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

test_clocknullable stringExpandable
ID of the test clock this credit balance transaction belongs to.

typenullable enum
The type of credit balance transaction (credit or debit).
Possible enum values
credit
A credit transaction.
debit
A debit transaction.

The Credit Balance Transaction object

{
  "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"
}

Retrieve a credit balance transaction

GET /v1/billing/credit_balance_transactions/:id

Retrieves a credit balance transaction.

Parameters

idstringRequired
Unique identifier for the object.

Returns

Returns a credit balance transaction.

curl https://api.stripe.com/v1/billing/credit_balance_transactions/cbtxn_test_61R9ZljjaFmdidb6e41L6nFOS1ekD9Ue \
  -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"

Response

{
  "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"
}

Credit Balance Transactions

The Credit Balance Transaction object

Attributes

idstring

objectstring

createdtimestamp

creditnullable object

credit_grantstringExpandable

debitnullable object

effective_attimestamp

livemodeboolean

test_clocknullable stringExpandable

typenullable enum

Retrieve a credit balance transaction

Parameters

idstringRequired

Returns