Create a customer credits account

Create a new credits account for a customer. Optionally seed it with an initial balance.

POST /v1/customer-credits/accounts

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.createAccount({
    customerId: "cust_abc123",
    initialBalance: "300",
  });

  console.log(result);
}

run();

201

{
  "id": "cca_abc123",
  "store_id": "<string>",
  "customer_id": "cust_abc123",
  "name": "default",
  "unit_label": "credits",
  "status": "active",
  "created_at": "<string>",
  "updated_at": "<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.

Body

application/json

customer_id · string · required

The owner ID this account belongs to (e.g. customer ID)

Example:

"cust_abc123"

name · string · default: default

Human-readable name for the account

Example:

"default"

unit_label · string · default: credits

Label for the unit of currency/credits

Example:

"credits"

initial_balance · string

Seed the account with this many credits on creation

Example:

"300"

Response

201

application/json

Account created

id · string · required

Account ID

Example:

"cca_abc123"

store_id · string · required

Store ID

customer_id · string · required

Owner ID

Example:

"cust_abc123"

name · string · required

Account name

Example:

"default"

unit_label · string · required

Unit label

Example:

"credits"

status · enum<string> · required

Account status

Available options: active, frozen, closed

created_at · string · required

Creation timestamp

updated_at · string · required

Last update timestamp