Read the billing state of a room booking installation

1 parameter

installation_idstringrequired

Room booking installation id

3 status codes

200The billing state

dataobjectoptional

401Unauthorized

errorstringoptional

404Installation belongs to another user

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Installation belongs to another user.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.billing.list({ installationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "data": {
    "amount_in_dollars": {
      "month": 8,
      "year": 80
    },
    "billable_resource_count": 42,
    "checkout_url": "https://example.com",
    "grace_until": "example_value",
    "locked": true,
    "portal_url": "https://example.com",
    "subscription": {
      "billed_quantity": 1,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": "month",
      "status": "active"
    },
    "subscription_required": true,
    "trial_days": 14
  }
}

Request

Response

Errors