> ## Documentation Index > Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Credit Entitlement > Creates a new credit entitlement for the authenticated business ## OpenAPI ````yaml post /credit-entitlements openapi: 3.1.0 info: title: public description: '' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.102.0 servers: - url: https://test.dodopayments.com/ description: Test Mode Server Host - url: https://live.dodopayments.com/ description: Live Mode Server Host security: [] tags: - name: Products - name: Payments - name: Subscriptions - name: Addons - name: Customers - name: Refunds - name: Disputes - name: Events - name: License Keys - name: Entitlements - name: Licenses - name: Discounts - name: Meters - name: Credit Entitlements - name: Credit Entitlement Balances - name: Outgoing Webhooks - name: Checkout - name: Webhook Events paths: /credit-entitlements: post: tags: - Credit Entitlements summary: Creates a new credit entitlement for the authenticated business. description: >- Credit entitlements define reusable credit templates that can be attached to products. Each entitlement defines how credits behave in terms of expiration, rollover, and overage. # Authentication Requires an API key with `Editor` role. # Request Body - `name` - Human-readable name of the credit entitlement (1-255 characters, required) - `description` - Optional description (max 1000 characters) - `precision` - Decimal precision for credit amounts (0-10 decimal places) - `unit` - Unit of measurement for the credit (e.g., "API Calls", "Tokens", "Credits") - `expires_after_days` - Number of days after which credits expire (optional) - `rollover_enabled` - Whether unused credits can rollover to the next period - `rollover_percentage` - Percentage of unused credits that rollover (0-100) - `rollover_timeframe_count` - Count of timeframe periods for rollover limit - `rollover_timeframe_interval` - Interval type (day, week, month, year) - `max_rollover_count` - Maximum number of times credits can be rolled over - `overage_enabled` - Whether overage charges apply when credits run out (requires price_per_unit) - `overage_limit` - Maximum overage units allowed (optional) - `currency` - Currency for pricing (required if price_per_unit is set) - `price_per_unit` - Price per credit unit (decimal) # Responses - `201 Created` - Credit entitlement created successfully, returns the full entitlement object - `422 Unprocessable Entity` - Invalid request parameters or validation failure - `500 Internal Server Error` - Database or server error # Business Logic - A unique ID with prefix `cde_` is automatically generated for the entitlement - Created and updated timestamps are automatically set - Currency is required when price_per_unit is set - price_per_unit is required when overage_enabled is true - rollover_timeframe_count and rollover_timeframe_interval must both be set or both be null operationId: create_credit_entitlement requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCreditEntitlementRequest' required: true responses: '201': description: Credit entitlement created successfully content: application/json: schema: $ref: '#/components/schemas/CreditEntitlementResponse' '422': description: Invalid Request Object or Parameters '500': description: Something went wrong :( security: - API_KEY: [] x-codeSamples: - lang: JavaScript source: |- import DodoPayments from 'dodopayments'; const client = new DodoPayments({ bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted }); const creditEntitlement = await client.creditEntitlements.create({ name: 'name', overage_enabled: true, precision: 0, rollover_enabled: true, unit: 'unit', }); console.log(creditEntitlement.id); - lang: Python source: |- import os from dodopayments import DodoPayments client = DodoPayments( bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted ) credit_entitlement = client.credit_entitlements.create( name="name", overage_enabled=True, precision=0, rollover_enabled=True, unit="unit", ) print(credit_entitlement.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/dodopayments/dodopayments-go\"\n\t\"github.com/dodopayments/dodopayments-go/option\"\n)\n\nfunc main() {\n\tclient := dodopayments.NewClient(\n\t\toption.WithBearerToken(\"My Bearer Token\"),\n\t)\n\tcreditEntitlement, err := client.CreditEntitlements.New(context.TODO(), dodopayments.CreditEntitlementNewParams{\n\t\tName: dodopayments.F(\"name\"),\n\t\tOverageEnabled: dodopayments.F(true),\n\t\tPrecision: dodopayments.F(int64(0)),\n\t\tRolloverEnabled: dodopayments.F(true),\n\t\tUnit: dodopayments.F(\"unit\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", creditEntitlement.ID)\n}\n" - lang: Java source: >- package com.dodopayments.api.example; import com.dodopayments.api.client.DodoPaymentsClient; import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient; import com.dodopayments.api.models.creditentitlements.CreditEntitlement; import com.dodopayments.api.models.creditentitlements.CreditEntitlementCreateParams; public final class Main { private Main() {} public static void main(String[] args) { DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv(); CreditEntitlementCreateParams params = CreditEntitlementCreateParams.builder() .name("name") .overageEnabled(true) .precision(0) .rolloverEnabled(true) .unit("unit") .build(); CreditEntitlement creditEntitlement = client.creditEntitlements().create(params); } } - lang: Kotlin source: >- package com.dodopayments.api.example import com.dodopayments.api.client.DodoPaymentsClient import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient import com.dodopayments.api.models.creditentitlements.CreditEntitlement import com.dodopayments.api.models.creditentitlements.CreditEntitlementCreateParams fun main() { val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv() val params: CreditEntitlementCreateParams = CreditEntitlementCreateParams.builder() .name("name") .overageEnabled(true) .precision(0) .rolloverEnabled(true) .unit("unit") .build() val creditEntitlement: CreditEntitlement = client.creditEntitlements().create(params) } - lang: Ruby source: |- require "dodopayments" dodo_payments = Dodopayments::Client.new( bearer_token: "My Bearer Token", environment: "test_mode" # defaults to "live_mode" ) credit_entitlement = dodo_payments.credit_entitlements.create( name: "name", overage_enabled: true, precision: 0, rollover_enabled: true, unit: "unit" ) puts(credit_entitlement) - lang: PHP source: |- creditEntitlements->create( name: 'name', overageEnabled: true, precision: 0, rolloverEnabled: true, unit: 'unit', currency: Currency::AED, description: 'description', expiresAfterDays: 0, maxRolloverCount: 0, overageBehavior: CbbOverageBehavior::FORGIVE_AT_RESET, overageLimit: 0, pricePerUnit: 'price_per_unit', rolloverPercentage: 0, rolloverTimeframeCount: 0, rolloverTimeframeInterval: TimeInterval::DAY, ); var_dump($creditEntitlement); } catch (APIException $e) { echo $e->getMessage(); } - lang: C# source: >- using System; using DodoPayments.Client; using DodoPayments.Client.Models.CreditEntitlements; DodoPaymentsClient client = new(); CreditEntitlementCreateParams parameters = new() { Name = "name", OverageEnabled = true, Precision = 0, RolloverEnabled = true, Unit = "unit", }; var creditEntitlement = await client.CreditEntitlements.Create(parameters); Console.WriteLine(creditEntitlement); components: schemas: CreateCreditEntitlementRequest: type: object required: - name - precision - unit - rollover_enabled - overage_enabled properties: currency: oneOf: - type: 'null' - $ref: '#/components/schemas/Currency' description: Currency for pricing (required if price_per_unit is set) description: type: - string - 'null' description: Optional description of the credit entitlement expires_after_days: type: - integer - 'null' format: int32 description: Number of days after which credits expire (optional) max_rollover_count: type: - integer - 'null' format: int32 description: Maximum number of times credits can be rolled over name: type: string description: Name of the credit entitlement overage_behavior: oneOf: - type: 'null' - $ref: '#/components/schemas/CbbOverageBehavior' description: |- Controls how overage is handled at billing cycle end. Defaults to forgive_at_reset if not specified. overage_enabled: type: boolean description: Whether overage charges are enabled when credits run out overage_limit: type: - integer - 'null' format: int64 description: Maximum overage units allowed (optional) precision: type: integer format: int32 description: Precision for credit amounts (0-10 decimal places) price_per_unit: type: - string - 'null' description: Price per credit unit rollover_enabled: type: boolean description: Whether rollover is enabled for unused credits rollover_percentage: type: - integer - 'null' format: int32 description: Percentage of unused credits that can rollover (0-100) rollover_timeframe_count: type: - integer - 'null' format: int32 description: Count of timeframe periods for rollover limit rollover_timeframe_interval: oneOf: - type: 'null' - $ref: '#/components/schemas/TimeInterval' description: Interval type for rollover timeframe unit: type: string description: >- Unit of measurement for the credit (e.g., "API Calls", "Tokens", "Credits") CreditEntitlementResponse: type: object required: - id - business_id - name - precision - unit - rollover_enabled - overage_enabled - overage_behavior - created_at - updated_at properties: business_id: type: string created_at: type: string format: date-time currency: oneOf: - type: 'null' - $ref: '#/components/schemas/Currency' description: type: - string - 'null' expires_after_days: type: - integer - 'null' format: int32 id: type: string max_rollover_count: type: - integer - 'null' format: int32 name: type: string overage_behavior: $ref: '#/components/schemas/CbbOverageBehavior' description: Controls how overage is handled at billing cycle end. overage_enabled: type: boolean overage_limit: type: - integer - 'null' format: int64 precision: type: integer format: int32 price_per_unit: type: - string - 'null' description: Price per credit unit rollover_enabled: type: boolean rollover_percentage: type: - integer - 'null' format: int32 rollover_timeframe_count: type: - integer - 'null' format: int32 rollover_timeframe_interval: oneOf: - type: 'null' - $ref: '#/components/schemas/TimeInterval' unit: type: string updated_at: type: string format: date-time Currency: type: string enum: - AED - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BWP - BYN - BZD - CAD - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SZL - THB - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW CbbOverageBehavior: type: string description: >- Controls how overage is handled at the end of a billing cycle. | Preset | Charge at billing | Credits reduce overage | Preserve overage at reset | |-------------------------|:-----------------:|:---------------------:|:-------------------------:| | `forgive_at_reset` | No | No | No | | `invoice_at_billing` | Yes | No | No | | `carry_deficit` | No | No | Yes | | `carry_deficit_auto_repay` | No | Yes | Yes | enum: - forgive_at_reset - invoice_at_billing - carry_deficit - carry_deficit_auto_repay TimeInterval: type: string enum: - Day - Week - Month - Year securitySchemes: API_KEY: type: http scheme: bearer ````