Credit types & wallets

Credit types define what a “credit” means in your system. Wallets hold a customer’s credit balance. You need both before you can grant credits through a pricing plan.


Credit types

A credit type is the unit of account for credits in your system. Before you can create a wallet or grant credits to a customer, you need at least one credit type defined.

Go to Product Catalog in the sidebar, then open Credits & Wallets and select the Credits tab. Click Add credit type.

Credits & Wallets page, credit types tab

Fill in the following fields:

FieldRequiredDescription
NameYesInternal label for this credit type (e.g. “Streaming credits”)
ReferenceYesUnique identifier
DescriptionNoOptional context for your team
Unit name singularNoHow a single credit appears in the UI (e.g. “Credit”)
Unit name pluralNoHow multiple credits appear in the UI (e.g. “Credits”)

Add credit type form

Click Save and activate to make the credit type available immediately, or Save as draft if you want to complete the configuration in a second moment.


Wallets

A wallet holds a customer’s balance for a given credit type. When credits are granted through a subscription, they are deposited into the matching wallet. When a customer consumes a usage-based product priced in credits, the balance is drawn down.

In Credits & Wallets, open the Wallets tab and click Add wallet.

Wallets tab, list view

Fill in the following fields:

FieldRequiredDescription
Wallet typeYesThe type of wallet. Select Credits for credit-based wallets
NameYesInternal label for this wallet
ReferenceYesUnique identifier
Grant typeYesHow the wallet is funded. Select Credits to fund with a credit type
Credit typeYesThe credit type this wallet holds

Create wallet form

A wallet is a template-level definition. The actual per-customer balance is tracked when a customer subscribes to a pricing plan that grants credits into this wallet.