Listar Saldos

Lista todos os saldos de clientes para um direito de crédito específico

GET /credit-entitlements/{credit_entitlement_id}/balances

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 customerCreditBalance of client.creditEntitlements.balances.list(
  'cde_ztxm5XJsKxWucRWA3rjdM',
)) {
  console.log(customerCreditBalance.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(
    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.List(
		context.TODO(),
		"cde_ztxm5XJsKxWucRWA3rjdM",
		dodopayments.CreditEntitlementBalanceListParams{},
	)
	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.BalanceListPage;
import com.dodopayments.api.models.creditentitlements.balances.BalanceListParams;

public final class Main {
    private Main() {}

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

        BalanceListPage page = client.creditEntitlements().balances().list("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.balances.BalanceListPage
import com.dodopayments.api.models.creditentitlements.balances.BalanceListParams

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

    val page: BalanceListPage = client.creditEntitlements().balances().list("cde_ztxm5XJsKxWucRWA3rjdM")
}

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("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->list(
    'cde_ztxm5XJsKxWucRWA3rjdM',
    customerID: 'customer_id',
    pageNumber: 0,
    pageSize: 0,
  );

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

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

DodoPaymentsClient client = new();

BalanceListParams parameters = new()
{
    CreditEntitlementID = "cde_ztxm5XJsKxWucRWA3rjdM"
};

var page = await client.CreditEntitlements.Balances.List(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 result = client
        .credit_entitlements()
        .balances()
        .list()
        .credit_entitlement_id(credit_entitlement_id)
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

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

200

{
  "items": [
    {
      "balance": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "credit_entitlement_id": "<string>",
      "customer_id": "<string>",
      "id": "<string>",
      "overage": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_transaction_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Autorizações

Authorization · string · header · obrigatório

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

Parâmetros de caminho

credit_entitlement_id · string · obrigatório

Credit Entitlement ID

Parâmetros de consulta

page_size · integer<int32>

Page size default is 10 max is 100

Intervalo obrigatório: x >= 0

page_number · integer<int32>

Page number default is 0

Intervalo obrigatório: x >= 0

customer_id · string

Filter by specific customer ID

Resposta

200

application/json

List of customer balances

items · object[] · obrigatório

Show child attributes