Update Credit Entitlement

Updates an existing credit entitlement with partial data

PATCH /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
});

await client.creditEntitlements.update('cde_ztxm5XJsKxWucRWA3rjdM');

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
)
client.credit_entitlements.update(
    id="cde_ztxm5XJsKxWucRWA3rjdM",
)

package main

import (
	"context"

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

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	err := client.CreditEntitlements.Update(
		context.TODO(),
		"cde_ztxm5XJsKxWucRWA3rjdM",
		dodopayments.CreditEntitlementUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.creditentitlements.CreditEntitlementUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        client.creditEntitlements().update("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.CreditEntitlementUpdateParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    client.creditEntitlements().update("cde_ztxm5XJsKxWucRWA3rjdM")
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

result = dodo_payments.credit_entitlements.update("cde_ztxm5XJsKxWucRWA3rjdM")

puts(result)

<?php

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

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\CreditEntitlements\CbbOverageBehavior;
use Dodopayments\Misc\Currency;
use Dodopayments\Subscriptions\TimeInterval;

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

try {
  $result = $client->creditEntitlements->update(
    'cde_ztxm5XJsKxWucRWA3rjdM',
    currency: Currency::AED,
    description: 'description',
    expiresAfterDays: 0,
    maxRolloverCount: 0,
    name: 'name',
    overageBehavior: CbbOverageBehavior::FORGIVE_AT_RESET,
    overageEnabled: true,
    overageLimit: 0,
    pricePerUnit: 'price_per_unit',
    rolloverEnabled: true,
    rolloverPercentage: 0,
    rolloverTimeframeCount: 0,
    rolloverTimeframeInterval: TimeInterval::DAY,
    unit: 'unit',
  );

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

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

DodoPaymentsClient client = new();

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

await client.CreditEntitlements.Update(parameters);

use dodopayments::Client;

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

curl --request PATCH \
  --url https://test.dodopayments.com/credit-entitlements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "expires_after_days": 123,
  "max_rollover_count": 123,
  "name": "<string>",
  "overage_enabled": true,
  "overage_limit": 123,
  "price_per_unit": "<string>",
  "rollover_enabled": true,
  "rollover_percentage": 123,
  "rollover_timeframe_count": 123,
  "unit": "<string>"
}
'

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

Body

application/json

currency · null | enum<string>

Currency for pricing

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

Optional description of the credit entitlement

expires_after_days · integer<int32> | null

Number of days after which credits expire

max_rollover_count · integer<int32> | null

Maximum number of times credits can be rolled over

name · string | null

Name of the credit entitlement

overage_behavior · null | enum<string>

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 | null

Whether overage charges are enabled when credits run out

overage_limit · integer<int64> | null

Maximum overage units allowed

price_per_unit · string | null

Price per credit unit

rollover_enabled · boolean | null

Whether rollover is enabled for unused credits

rollover_percentage · integer<int32> | null

Percentage of unused credits that can rollover (0-100)

rollover_timeframe_count · integer<int32> | null

Count of timeframe periods for rollover limit

rollover_timeframe_interval · null | enum<string>

Interval type for rollover timeframe

Available options: Day, Week, Month, Year

unit · string | null

Unit of measurement for the credit (e.g., "API Calls", "Tokens", "Credits")

Response

200

Credit entitlement updated successfully