Liệt kê Sổ cái Khách hàng

Liệt kê các mục sổ cái cho một khách hàng theo quyền tín dụng cụ thể

GET /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger

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

// Automatically fetches more pages as needed.
for await (const creditLedgerEntry of client.creditEntitlements.balances.listLedger(
  'cus_TV52uJWWXt2yIoBBxpjaa',
  { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
)) {
  console.log(creditLedgerEntry.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
)
page = client.credit_entitlements.balances.list_ledger(
    customer_id="cus_TV52uJWWXt2yIoBBxpjaa",
    credit_entitlement_id="cde_ztxm5XJsKxWucRWA3rjdM",
)
page = page.items[0]
print(page.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"),
	)
	page, err := client.CreditEntitlements.Balances.ListLedger(
		context.TODO(),
		"cde_ztxm5XJsKxWucRWA3rjdM",
		"cus_TV52uJWWXt2yIoBBxpjaa",
		dodopayments.CreditEntitlementBalanceListLedgerParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

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.BalanceListLedgerPage;
import com.dodopayments.api.models.creditentitlements.balances.BalanceListLedgerParams;

public final class Main {
    private Main() {}

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

        BalanceListLedgerParams params = BalanceListLedgerParams.builder()
            .creditEntitlementId("cde_ztxm5XJsKxWucRWA3rjdM")
            .customerId("cus_TV52uJWWXt2yIoBBxpjaa")
            .build();
        BalanceListLedgerPage page = client.creditEntitlements().balances().listLedger(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.BalanceListLedgerPage
import com.dodopayments.api.models.creditentitlements.balances.BalanceListLedgerParams

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

    val params: BalanceListLedgerParams = BalanceListLedgerParams.builder()
        .creditEntitlementId("cde_ztxm5XJsKxWucRWA3rjdM")
        .customerId("cus_TV52uJWWXt2yIoBBxpjaa")
        .build()
    val page: BalanceListLedgerPage = client.creditEntitlements().balances().listLedger(params)
}

require "dodopayments"

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

page = dodo_payments.credit_entitlements.balances.list_ledger(
  "cus_TV52uJWWXt2yIoBBxpjaa",
  credit_entitlement_id: "cde_ztxm5XJsKxWucRWA3rjdM"
)

puts(page)

<?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 {
  $page = $client->creditEntitlements->balances->listLedger(
    'cus_TV52uJWWXt2yIoBBxpjaa',
    creditEntitlementID: 'cde_ztxm5XJsKxWucRWA3rjdM',
    endDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    pageNumber: 0,
    pageSize: 0,
    startDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    transactionType: 'transaction_type',
  );

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

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

DodoPaymentsClient client = new();

BalanceListLedgerParams parameters = new()
{
    CreditEntitlementID = "cde_ztxm5XJsKxWucRWA3rjdM",
    CustomerID = "cus_TV52uJWWXt2yIoBBxpjaa",
};

var page = await client.CreditEntitlements.Balances.ListLedger(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

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()
        .list_ledger()
        .credit_entitlement_id(credit_entitlement_id)
        .customer_id(customer_id)
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

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

200

{
  "items": [
    {
      "amount": "<string>",
      "balance_after": "<string>",
      "balance_before": "<string>",
      "brand_id": "<string>",
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "credit_entitlement_id": "<string>",
      "customer_id": "<string>",
      "id": "<string>",
      "is_credit": true,
      "metadata": {},
      "overage_after": "<string>",
      "overage_before": "<string>",
      "description": "<string>",
      "grant_id": "<string>",
      "reference_id": "<string>",
      "reference_type": "<string>"
    }
  ]
}

Ủy quyền

Authorization · string · header · bắt buộc

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

Tham số đường dẫn

credit_entitlement_id · string · bắt buộc

Credit Entitlement ID

customer_id · string · bắt buộc

Customer ID

Tham số truy vấn

page_size · integer<int32>

Page size default is 10 max is 100

Phạm vi bắt buộc: x >= 0

page_number · integer<int32>

Page number default is 0

Phạm vi bắt buộc: x >= 0

transaction_type · string

Filter by transaction type (snake_case: credit_added, credit_deducted, credit_expired, etc.)

start_date · string<date-time>

Filter by start date

end_date · string<date-time>

Filter by end date

Phản hồi

200

application/json

List of ledger entries

items · object[] · bắt buộc

Show child attributes