Skip to main content
PATCH
/
api
/
v1
/
credits
/
custom-currencies
/
{currencyId}
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const customCurrencyResponse = await client.v1.credits.customCurrencies.update('currencyId');

console.log(customCurrencyResponse.data);
import os
from stigg import Stigg

client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
custom_currency_response = client.v1.credits.custom_currencies.update(
currency_id="currencyId",
)
print(custom_currency_response.data)
package main

import (
"context"
"fmt"

"github.com/stiggio/stigg-go"
"github.com/stiggio/stigg-go/option"
)

func main() {
client := stigg.NewClient(
option.WithAPIKey("My API Key"),
)
customCurrencyResponse, err := client.V1.Credits.CustomCurrencies.Update(
context.TODO(),
"currencyId",
stigg.V1CreditCustomCurrencyUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", customCurrencyResponse.Data)
}
package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.credits.customcurrencies.CustomCurrencyResponse;
import io.stigg.models.v1.credits.customcurrencies.CustomCurrencyUpdateParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
StiggClient client = StiggOkHttpClient.fromEnv();

CustomCurrencyResponse customCurrencyResponse = client.v1().credits().customCurrencies().update("currencyId");
}
}
require "stigg"

stigg = Stigg::Client.new(api_key: "My API Key")

custom_currency_response = stigg.v1.credits.custom_currencies.update("currencyId")

puts(custom_currency_response)
using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Credits.CustomCurrencies;

StiggClient client = new();

CustomCurrencyUpdateParams parameters = new() { CurrencyID = "currencyId" };

var customCurrencyResponse = await client.V1.Credits.CustomCurrencies.Update(parameters);

Console.WriteLine(customCurrencyResponse);
stigg v1:credits:custom-currencies update \
--api-key 'My API Key' \
--currency-id currencyId
curl --request PATCH \
--url https://api.stigg.io/api/v1/credits/custom-currencies/{currencyId} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"displayName": "<string>",
"symbol": "<string>",
"description": "<string>",
"metadata": {}
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stigg.io/api/v1/credits/custom-currencies/{currencyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => '<string>',
'symbol' => '<string>',
'description' => '<string>',
'metadata' => [

]
]),
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;
}
{
  "data": {
    "id": "cred-type-credits",
    "displayName": "Credits",
    "symbol": "CR",
    "description": "Prepaid usage credits",
    "units": {
      "singular": "credit",
      "plural": "credits"
    },
    "metadata": {},
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "archivedAt": null
  }
}
{
"message": "<string>"
}
{
"message": "<string>",
"code": "Unauthenticated"
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"code": "RateLimitExceeded"
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

currencyId
string
required

The reference ID of the custom currency

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Body

application/json

Request body for updating an existing custom currency. Only supplied fields are modified.

displayName
string

The display name of the custom currency

Maximum string length: 64
symbol
string | null

The symbol used to represent the custom currency. Send an empty string to clear.

Maximum string length: 64
description
string | null

A human-readable description of the custom currency. Send an empty string to clear.

Maximum string length: 255
units
UnitsRequest · object

Singular and plural unit labels for a custom currency. Both fields are required when supplied.

metadata
object | null

Additional metadata to attach to the custom currency

Response

The updated custom currency object.

Response object

data
CustomCurrency · object
required

A custom currency used to denominate credit-based entitlements and pricing