Credit currency

​

Creating a credit type

1. Go to Product Catalog > Credits.

2. Click + Add credit type.

3. Enter the name of the credit type in the Name field.
4. Provide a description in the Description field.
5. An ID will be generated automatically and cannot be edited.
6. To define how singular and plural units are displayed, click Edit in the Units field and enter:
   • One: the singular name (e.g., credit).
   • Many: the plural name (e.g., credits).

7. Click Save changes.

8. If you need to edit an existing credit type, select the three dots next to it and click Edit.

​

Archiving a credit type

• Customers with an existing credit pool of this type - the pool remains visible and credits continue to be consumed normally. An indication is shown that the credit pool has been archived. It is not possible to grant additional credits to this pool.
• Customers without a credit pool of this type - the credit type is not visible and credits cannot be granted from it.
• The credit type is not available when configuring new plans or add-ons.
• You can view archived credit types in the archived list.
• A credit type can be unarchived to make it available again.

1. Click the dotted menu icon next to the relevant credit type.
2. Select Archive.
3. In the confirmation modal, enter the credit type name and click Archive.

​

Viewing archived credit types

1. Go to Product Catalog > Credits.
2. Use the Status filter and select Archived.

​

Unarchiving a credit type

1. Go to Product Catalog > Credits.
2. Use the Status filter and select Archived to find the credit type.
3. Click the dotted menu icon next to the relevant credit type.
4. Select Unarchive.

​

Using the GraphQL API (legacy)

mutation UnarchiveCreditType($input: UnarchiveCreditTypeInput!) {
  unarchiveCreditType(input: $input) {
    id
    status
  }
}

{
  "input": {
    "id": "credit-type-ai-tokens"
  }
}

​

Using the REST API

POST /api/v1/custom-currencies/{id}/unarchive