List plan overage charges

Retrieves the list of overage charges configured on a plan.

GET /api/v1/plans/{id}/overage-charges

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const planListOverageChargesResponse of client.v1.plans.listOverageCharges('x')) {
  console.log(planListOverageChargesResponse.id);
}

200

{
  "data": [],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID · string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Query Parameters

after · string<uuid>

Return items that come after this cursor

before · string<uuid>

Return items that come before this cursor

limit · integer · default: 20

Maximum number of items to return

Required range: 1 <= x <= 100

Response

200

application/json

The list of overage charges on the plan.

Response list object

data · Charge · object[] · required

Show child attributes

pagination · object · required

Pagination metadata including cursors for navigating through results

Show child attributes