Skip to main content
Credit entitlements grant customers a recurring amount of credits on a set cadence (monthly or yearly) as part of their add-on subscription. This is useful when you want to sell additional credit capacity on top of what a plan already provides.

​
Adding a credit entitlement

  1. Click ”+ Add” under the Entitlements section of the selected add-on.
  2. Select the credit type from the list (e.g., API Credits).
  3. Enter the amount of credits to grant per cadence (e.g., 10,000).
  4. Select the cadence: Monthly or Yearly.
  5. Click “Add” to confirm.
The credit type must already exist in your product catalog before it can be assigned as an add-on entitlement. To create a new credit type, go to Product Catalog > Credit types.

​
Example use case: “Extra API Credits” add-on

Suppose your base plan includes 50,000 API credits per month. You want to offer customers the ability to purchase additional credit capacity without upgrading their plan. Setup:
  1. Create an add-on named Extra API Credits with Multiple instance type, so customers can purchase more than one unit.
  2. Add a credit entitlement:
    • Credit type: API Credits
    • Amount: 10,000
    • Cadence: Monthly
  3. Set the add-on price and publish it.
Result: A customer on the base plan who purchases 3 units of the Extra API Credits add-on receives:
  • 50,000 credits from the plan
  • 30,000 credits from the add-on (10,000 × 3)
  • 80,000 API credits per month in total
Credits from the plan and from the add-on are pooled together in the customer’s credit balance and consumed in the order defined by your credit consumption logic.