Get Credit Entitlement

Retrieves a specific credit entitlement by its ID

GET /credit-entitlements/{id}

JavaScript

JavaScript

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('cde_ztxm5XJsKxWucRWA3rjdM');

console.log(creditEntitlement.id);

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(
    "cde_ztxm5XJsKxWucRWA3rjdM",
)
print(credit_entitlement.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	creditEntitlement, err := client.CreditEntitlements.Get(context.TODO(), "cde_ztxm5XJsKxWucRWA3rjdM")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", creditEntitlement.ID)
}

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("cde_ztxm5XJsKxWucRWA3rjdM");
    }
}

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("cde_ztxm5XJsKxWucRWA3rjdM")
}

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("cde_ztxm5XJsKxWucRWA3rjdM")

puts(credit_entitlement)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $creditEntitlement = $client->creditEntitlements->retrieve(
    'cde_ztxm5XJsKxWucRWA3rjdM'
  );

  var_dump($creditEntitlement);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.CreditEntitlements;

DodoPaymentsClient client = new();

CreditEntitlementRetrieveParams parameters = new()
{
    ID = "cde_ztxm5XJsKxWucRWA3rjdM"
};

var creditEntitlement = await client.CreditEntitlements.Retrieve(parameters);

Console.WriteLine(creditEntitlement);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let id = "id";
    let result = client
        .credit_entitlements()
        .retrieve()
        .id(id)
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request GET \
  --url https://test.dodopayments.com/credit-entitlements/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "overage_enabled": true,
  "precision": 123,
  "rollover_enabled": true,
  "unit": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "expires_after_days": 123,
  "max_rollover_count": 123,
  "overage_limit": 123,
  "price_per_unit": "<string>",
  "rollover_percentage": 123,
  "rollover_timeframe_count": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Credit Entitlement ID

Response

200

application/json

Credit entitlement details

business_id · string · required

created_at · string<date-time> · required

id · string · required

name · string · required

overage_behavior · enum<string> · required

Controls how overage is handled at billing cycle end.

Available options: forgive_at_reset, invoice_at_billing, carry_deficit, carry_deficit_auto_repay

overage_enabled · boolean · required

precision · integer<int32> · required

rollover_enabled · boolean · required

unit · string · required

updated_at · string<date-time> · required

currency · null | enum<string>

Available options: 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

description · string | null

expires_after_days · integer<int32> | null

max_rollover_count · integer<int32> | null

overage_limit · integer<int64> | null

price_per_unit · string | null

Price per credit unit

rollover_percentage · integer<int32> | null

rollover_timeframe_count · integer<int32> | null

rollover_timeframe_interval · null | enum<string>

Unit of a duration count (e.g. license-key validity period).

Available options: Day, Week, Month, Year