Getting started

This page is a structural placeholder. It walks through the shape of a getting-started guide so the layout, the sidebar and the table of contents can be reviewed before the real copy lands.

Install the SDK#

The SDK ships as a single package with no peer dependencies. Pick the tool your project already uses.

npm install @verlix/sdk

Make your first request#

1. 1

   Create an API key

   Generate a key from the dashboard. Keys are shown once, so store it in your secret manager immediately.

2. 2

   Authenticate the client

   Pass the key to the client constructor. The client reads the key once and reuses it for every request.

3. 3

   Call an endpoint

   Request the customers list and check the response envelope before you build on it.

import { Verlix } from "@verlix/sdk";
 
const client = new Verlix({ apiKey: process.env.VERLIX_API_KEY });
 
const customers = await client.customers.list({ limit: 10 });
console.log(customers.data.length);

What you can build#

Rate limits#

Next steps#

Read the authentication guide to understand key scopes, then set up webhooks so your system reacts to billing events.