Get account balance

Get the current balance of an account. Optionally pass ?at= for historical balance.

GET /v1/customer-credits/accounts/{id}/balance

TypeScript SDK

TypeScript

import { Creem } from "creem";

const creem = new Creem({
  apiKey: process.env["CREEM_API_KEY"] ?? "",
});

async function run() {
  const result = await creem.customerCredits.getAccountBalance("<id>", "2024-01-15T00:00:00.000Z");

  console.log(result);
}

run();

200

{
  "balance": "5000",
  "updated_at": "<string>",
  "as_of": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id · string · required

Query Parameters

at · string

ISO 8601 date. If present, computes balance at that point in time. If absent, returns O(1) projected balance.

Example:

"2024-01-15T00:00:00.000Z"

Response

200

application/json

Account balance

balance · string · required

Current balance as string for bigint safety

Example:

"5000"

updated_at · string

Last update timestamp (present for projected balance)

as_of · string

Point-in-time the balance was computed at (present for at-time queries)