paiment SDK

Server-side SDKs for the paiment API. Register subscribers, report LLM usage, manage plans.

Install

npm install @paiment/sdk

pip install paiment

Setup

Create an API key in Settings → API Keys.

import { PaimentClient } from '@paiment/sdk';

const paiment = new PaimentClient({
  apiKey: process.env.PAIMENT_API_KEY!,
  // defaults to https://api.paiment.tech
});

from paiment import PaimentClient

client = PaimentClient(api_key="tenantId:workspaceId:secret")

Quick start

Most integrations need three hooks:

1. User subscribes → subscriptions.create
2. LLM call completes → usage.report
3. User cancels → subscriptions.end

const sub = await paiment.subscriptions.create({
  userId: 'user_123',
  externalPlanId: 'price_pro',
  planName: 'Pro',    // optional naming hint
  price: 2999,        // cents
  currency: 'USD',
  interval: 'monthly',
});

await paiment.usage.report({
  userId: 'user_123',
  inputTokens: 1250,
  outputTokens: 340,
  provider: 'openai',
  model: 'gpt-4o',
  externalPlanId: 'price_pro',
});

await paiment.subscriptions.end(sub.id);

sub = client.subscriptions.create(
    user_id="user_123",
    external_plan_id="price_pro",
    plan_name="Pro",
    price=2999,
    currency="USD",
    interval="monthly",
)

client.usage.report(
    user_id="user_123",
    input_tokens=1250,
    output_tokens=340,
    provider="openai",
    model="gpt-4o",
    external_plan_id="price_pro",
)

client.subscriptions.end(sub.id)

Billing webhooks

paiment does not receive your payment-processor webhooks. Your server handles checkout and subscription events, then calls the SDK to sync billing state.

// After your billing provider confirms a new subscription
await paiment.subscriptions.create({
  userId: user.id,
  externalPlanId: plan.id,
  planName: 'Pro',
  price: 2999,
  currency: 'USD',
  interval: 'monthly',
  source: 'billing-webhook',
});

API reference

subscriptions

usage

users

plans

Key fields

Errors