Listar Direitos de Crédito

Lista todos os direitos de crédito para o negócio autenticado com suporte a paginação

GET /credit-entitlements

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 creditEntitlement of client.creditEntitlements.list()) {
  console.log(creditEntitlement.id);
}

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "overage_enabled": true,
      "precision": 123,
      "rollover_enabled": true,
      "unit": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "expires_after_days": 123,
      "max_rollover_count": 123,
      "overage_limit": 123,
      "price_per_unit": "<string>",
      "rollover_percentage": 123,
      "rollover_timeframe_count": 123
    }
  ]
}

Autorizações

Authorization · string · header · obrigatório

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

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

deleted · boolean

List deleted credit entitlements

Resposta

200

application/json

Credit Entitlements List

items · object[] · obrigatório

Show child attributes