Delete Credit Entitlement

Soft-deletes a credit entitlement by its ID

DELETE /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.delete('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.delete(
    "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.Delete(context.TODO(), "cde_ztxm5XJsKxWucRWA3rjdM")
	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.CreditEntitlementDeleteParams;

public final class Main {
    private Main() {}

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

        client.creditEntitlements().delete("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.CreditEntitlementDeleteParams

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

    client.creditEntitlements().delete("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.delete("cde_ztxm5XJsKxWucRWA3rjdM")

puts(result)

<?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 {
  $result = $client->creditEntitlements->delete('cde_ztxm5XJsKxWucRWA3rjdM');

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

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

DodoPaymentsClient client = new();

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

await client.CreditEntitlements.Delete(parameters);

use dodopayments::Client;

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

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

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

Credit entitlement deleted successfully