Pular para o conteúdo principal
GET
/
credit-entitlements
/
{credit_entitlement_id}
/
balances
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(
  'credit_entitlement_id',
)) {
  console.log(customerCreditBalance.id);
}
{
  "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

List of customer balances

items
object[]
obrigatório