Skip to main content
POST
/
v1
/
customer-credits
/
accounts
Create a customer credits account
curl --request POST \
  --url https://api.creem.io/v1/customer-credits/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "customer_id": "cust_abc123",
  "name": "default",
  "unit_label": "credits",
  "initial_balance": "300"
}
'
{
  "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

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