Get Customer Balance

Gets a specific customer’s balance for a credit entitlement

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

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

const customerCreditBalance = await client.creditEntitlements.balances.retrieve('customer_id', {
  credit_entitlement_id: 'credit_entitlement_id',
});

console.log(customerCreditBalance.id);

200

{
  "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"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

credit_entitlement_id · string · required

Credit Entitlement ID

customer_id · string · required

Customer ID

Response

200

application/json

Customer balance details

Response for a customer's credit balance

balance · string · required

created_at · string<date-time> · required

credit_entitlement_id · string · required

customer_id · string · required

id · string · required

overage · string · required

updated_at · string<date-time> · required

last_transaction_at · string<date-time> | null