> ## 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. # Get Credit Entitlement > Retrieves a specific credit entitlement by its ID ## OpenAPI ````yaml get /credit-entitlements/{id} openapi: 3.1.0 info: title: public description: '' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.105.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/{id}: get: tags: - Credit Entitlements summary: Retrieves a specific credit entitlement by its ID. description: >- Returns the full details of a single credit entitlement including all configuration settings for expiration, rollover, and overage policies. # Authentication Requires an API key with `Viewer` role or higher. # Path Parameters - `id` - The unique identifier of the credit entitlement (format: `cde_...`) # Responses - `200 OK` - Returns the full credit entitlement object - `404 Not Found` - Credit entitlement does not exist or does not belong to the authenticated business - `500 Internal Server Error` - Database or server error # Business Logic - Only non-deleted credit entitlements can be retrieved through this endpoint - The entitlement must belong to the authenticated business (business_id check) - Deleted entitlements return a 404 error and must be retrieved via the list endpoint with `deleted=true` operationId: get_credit_entitlement_handler parameters: - name: id in: path description: Credit Entitlement ID required: true schema: type: string responses: '200': description: Credit entitlement details content: application/json: schema: $ref: '#/components/schemas/CreditEntitlementResponse' '404': description: Credit entitlement not found '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.retrieve('id'); 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.retrieve( "id", ) 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.Get(context.TODO(), \"id\")\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.CreditEntitlementRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv(); CreditEntitlement creditEntitlement = client.creditEntitlements().retrieve("id"); } } - 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.CreditEntitlementRetrieveParams fun main() { val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv() val creditEntitlement: CreditEntitlement = client.creditEntitlements().retrieve("id") } - 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.retrieve("id") puts(credit_entitlement) - lang: PHP source: |- creditEntitlements->retrieve('id'); 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(); CreditEntitlementRetrieveParams parameters = new() { ID = "id" }; var creditEntitlement = await client.CreditEntitlements.Retrieve(parameters); Console.WriteLine(creditEntitlement); components: schemas: 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 ````