メインコンテンツへスキップ
POST
/
credit-entitlements
/
{credit_entitlement_id}
/
balances
/
{customer_id}
/
ledger-entries
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 response = await client.creditEntitlements.balances.createLedgerEntry(
  'cus_TV52uJWWXt2yIoBBxpjaa',
  {
    credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM',
    amount: 'amount',
    entry_type: 'credit',
  },
);

console.log(response.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
)
response = client.credit_entitlements.balances.create_ledger_entry(
customer_id="cus_TV52uJWWXt2yIoBBxpjaa",
credit_entitlement_id="cde_ztxm5XJsKxWucRWA3rjdM",
amount="amount",
entry_type="credit",
)
print(response.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"),
)
response, err := client.CreditEntitlements.Balances.NewLedgerEntry(
context.TODO(),
"cde_ztxm5XJsKxWucRWA3rjdM",
"cus_TV52uJWWXt2yIoBBxpjaa",
dodopayments.CreditEntitlementBalanceNewLedgerEntryParams{
Amount: dodopayments.F("amount"),
EntryType: dodopayments.F(dodopayments.LedgerEntryTypeCredit),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.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.balances.BalanceCreateLedgerEntryParams;
import com.dodopayments.api.models.creditentitlements.balances.BalanceCreateLedgerEntryResponse;
import com.dodopayments.api.models.creditentitlements.balances.LedgerEntryType;

public final class Main {
private Main() {}

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

BalanceCreateLedgerEntryParams params = BalanceCreateLedgerEntryParams.builder()
.creditEntitlementId("cde_ztxm5XJsKxWucRWA3rjdM")
.customerId("cus_TV52uJWWXt2yIoBBxpjaa")
.amount("amount")
.entryType(LedgerEntryType.CREDIT)
.build();
BalanceCreateLedgerEntryResponse response = client.creditEntitlements().balances().createLedgerEntry(params);
}
}
package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.creditentitlements.balances.BalanceCreateLedgerEntryParams
import com.dodopayments.api.models.creditentitlements.balances.BalanceCreateLedgerEntryResponse
import com.dodopayments.api.models.creditentitlements.balances.LedgerEntryType

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

val params: BalanceCreateLedgerEntryParams = BalanceCreateLedgerEntryParams.builder()
.creditEntitlementId("cde_ztxm5XJsKxWucRWA3rjdM")
.customerId("cus_TV52uJWWXt2yIoBBxpjaa")
.amount("amount")
.entryType(LedgerEntryType.CREDIT)
.build()
val response: BalanceCreateLedgerEntryResponse = client.creditEntitlements().balances().createLedgerEntry(params)
}
require "dodopayments"

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

response = dodo_payments.credit_entitlements.balances.create_ledger_entry(
"cus_TV52uJWWXt2yIoBBxpjaa",
credit_entitlement_id: "cde_ztxm5XJsKxWucRWA3rjdM",
amount: "amount",
entry_type: :credit
)

puts(response)
<?php

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

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\CreditEntitlements\Balances\LedgerEntryType;

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

try {
$response = $client->creditEntitlements->balances->createLedgerEntry(
'cus_TV52uJWWXt2yIoBBxpjaa',
creditEntitlementID: 'cde_ztxm5XJsKxWucRWA3rjdM',
amount: 'amount',
entryType: LedgerEntryType::CREDIT,
expiresAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
idempotencyKey: 'idempotency_key',
metadata: ['foo' => 'string'],
reason: 'reason',
);

var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.CreditEntitlements.Balances;

DodoPaymentsClient client = new();

BalanceCreateLedgerEntryParams parameters = new()
{
CreditEntitlementID = "cde_ztxm5XJsKxWucRWA3rjdM",
CustomerID = "cus_TV52uJWWXt2yIoBBxpjaa",
Amount = "amount",
EntryType = LedgerEntryType.Credit,
};

var response = await client.CreditEntitlements.Balances.CreateLedgerEntry(parameters);

Console.WriteLine(response);
use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let credit_entitlement_id = "credit_entitlement_id";
let customer_id = "customer_id";
let result = client
.credit_entitlements()
.balances()
.create_ledger_entry()
.credit_entitlement_id(credit_entitlement_id)
.customer_id(customer_id)
.body(dodopayments::models::CreditEntitlementsBalancesCreateLedgerEntryParams {
amount: Some("amount".to_string()),
entry_type: Some(Box::new(dodopayments::models::LedgerEntryType::Credit)),
..Default::default()
})
.await?;
println!("{result:?}");
Ok(())
}
curl --request POST \
--url https://test.dodopayments.com/credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"metadata": {},
"reason": "<string>"
}
'
{
  "amount": "<string>",
  "balance_after": "<string>",
  "balance_before": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "credit_entitlement_id": "<string>",
  "customer_id": "<string>",
  "id": "<string>",
  "is_credit": true,
  "overage_after": "<string>",
  "overage_before": "<string>",
  "grant_id": "<string>",
  "reason": "<string>"
}

承認

Authorization
string
header
必須

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

パスパラメータ

credit_entitlement_id
string
必須

Credit Entitlement ID

customer_id
string
必須

Customer ID

ボディ

application/json

Request to create a ledger entry (credit or debit)

amount
string
必須

Amount to credit or debit

entry_type
enum<string>
必須

Entry type: credit or debit

利用可能なオプション:
credit,
debit
expires_at
string<date-time> | null

Expiration for credited amount (only for credit type)

idempotency_key
string | null

Idempotency key to prevent duplicate entries

metadata
null | Metadata · object

Optional metadata (max 50 key-value pairs, key max 40 chars, value max 500 chars)

reason
string | null

Human-readable reason for the entry

レスポンス

Ledger entry created successfully

Response for creating a ledger entry

amount
string
必須
balance_after
string
必須
balance_before
string
必須
created_at
string<date-time>
必須
credit_entitlement_id
string
必須
customer_id
string
必須
entry_type
enum<string>
必須
利用可能なオプション:
credit,
debit
id
string
必須
is_credit
boolean
必須
overage_after
string
必須
overage_before
string
必須
grant_id
string | null
reason
string | null
最終更新日 2026年4月1日