Get billable user information | Sample

2 parameters

tokenstringrequired

Authentication token with the `admin` scope.

userstringoptional

User whose billable information to retrieve; defaults to all users when omitted.

2 status codes

200Returns an object with `ok` set to true for a successful billable information request.

okbooleanrequired

Allowed:true

defaultReturns an error response with `ok` set to false.

okbooleanrequired

Allowed:false

Error handling

Supply token with the admin scope. If you provide user, it must identify the user whose billable information you want to retrieve; omit it to request all users.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.teamBillableInfo.list({
  token: "sk_live_4eC39Hq",
  user: "octocat",
});

{
  "billable_info": {
    "U02UCPE1R": {
      "billing_active": true
    },
    "U02UEBSD2": {
      "billing_active": true
    },
    "U0632EWRW": {
      "billing_active": false
    }
  },
  "ok": true
}

Request

Response

Errors