# Credit System / Balance Transaction

### Overview

The API has a customer credit system will allows customers to add store credit for use on future orders. Credit can be added with Stripe or any other payment method.

We use Stripes credit system which is formed around Balance Transaction objects and creates an immutable ledger of all transactions which can credit or debit the customer credit balance.

Our internal BalanceTransaction objects are automatically synced from their Stripe equivalents using webhooks.

### Automatic Credit Application

If a customer has a positive credit balance, it will automatically be applied to any new Stripe invoices at the time of invoice generation. The credit balance can only be returned if that invoice is voided.

### **Credit Top Ups**

To add a credit balance, you need to use the Checkout API Route with is\_top\_up as True and top\_amount as an integer in cents.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://internal.developer.documentation.private.user.pingproxies.com/checkout-and-payments/credit-system-balance-transaction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
