Retrieve a customer credits account

TypeScript SDK

import { Creem } from "creem";

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

async function run() {
  const result = await creem.customerCredits.getAccount("<id>");

  console.log(result);
}

run();

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.creem.io/v1/customer-credits/accounts/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "cca_abc123",
  "store_id": "<string>",
  "customer_id": "cust_abc123",
  "name": "default",
  "unit_label": "credits",
  "status": "active",
  "created_at": "<string>",
  "updated_at": "<string>"
}

GET

customer-credits

accounts

{id}

TypeScript SDK

import { Creem } from "creem";

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

async function run() {
  const result = await creem.customerCredits.getAccount("<id>");

  console.log(result);
}

run();

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.creem.io/v1/customer-credits/accounts/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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.

Path Parameters

string

required

Response

Account details

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

API Documentation

Checkout

Product

Customer

Transactions

License

Discount Code

Subscription

Stats

Customer Credits

Moderation

Retrieve a customer credits account

Authorizations

Path Parameters

Response