Retrieve Credit Usage

Retrieve the credit usage for a subscription.

GET /subscriptions/{subscription_id}/credit-usage

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 response = await client.subscriptions.retrieveCreditUsage('sub_Iuaq622bbmmfOGrVTqdXv');

console.log(response.subscription_id);

200

{
  "items": [
    {
      "balance": "250.00",
      "credit_entitlement_id": "<string>",
      "credit_entitlement_name": "<string>",
      "limit_reached": true,
      "overage": "15.50",
      "overage_enabled": true,
      "unit": "<string>",
      "overage_limit": "100.00",
      "remaining_headroom": "84.50"
    }
  ],
  "subscription_id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

subscription_id · string · required

Subscription ID

Response

200 - application/json

Credit usage status for all entitlements linked to a subscription

items · object[] · required

Show child attributes

subscription_id · string · required