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"
}
'
import requests

url = "https://api.creem.io/v1/customer-credits/accounts"

payload = {
"customer_id": "cust_abc123",
"name": "default",
"unit_label": "credits",
"initial_balance": "300"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: 'cust_abc123',
name: 'default',
unit_label: 'credits',
initial_balance: '300'
})
};

fetch('https://api.creem.io/v1/customer-credits/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creem.io/v1/customer-credits/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => 'cust_abc123',
'name' => 'default',
'unit_label' => 'credits',
'initial_balance' => '300'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.creem.io/v1/customer-credits/accounts"

payload := strings.NewReader("{\n \"customer_id\": \"cust_abc123\",\n \"name\": \"default\",\n \"unit_label\": \"credits\",\n \"initial_balance\": \"300\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.creem.io/v1/customer-credits/accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"cust_abc123\",\n \"name\": \"default\",\n \"unit_label\": \"credits\",\n \"initial_balance\": \"300\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.creem.io/v1/customer-credits/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"cust_abc123\",\n \"name\": \"default\",\n \"unit_label\": \"credits\",\n \"initial_balance\": \"300\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "cca_abc123",
  "store_id": "<string>",
  "customer_id": "cust_abc123",
  "name": "default",
  "unit_label": "credits",
  "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