Skip to content
BranchesTags

Repository files navigation

paygentic

Developer-friendly & type-safe Typescript SDK specifically catered to leverage paygentic API.



Summary

Paygentic API: The Paygentic API provides billing infrastructure for usage-based and subscription monetization — customers, subscriptions, usage metering, invoicing, entitlements, and payments.

See the Quickstart to go from zero to billing in a handful of steps.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @paygentic/sdk

PNPM

pnpm add @paygentic/sdk

Bun

bun add @paygentic/sdk

Yarn

yarn add @paygentic/sdk

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Create a customer

Create a customer for each organization you bill. This is the first step in the billing setup — see the Quickstart for the full flow.

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.customers.create({
    consumer: {
      name: "Jane Smith",
      email: "jane@example.com",
      address: {
        city: "San Francisco",
        state: "CA",
        country: "US",
      },
    },
    merchantId: "org_YS8jkP59V71TdUvj",
  });

  console.log(result);
}

run();

Create a subscription

Subscribe a customer to a plan. If the plan includes in-advance charges, Paygentic generates an initial invoice and the subscription activates once paid.

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.subscriptions.create({
    customerId: "cus_abc123",
    name: "Monthly API Service",
    planId: "plan_abc123",
    startedAt: new Date("2024-01-15T00:00:00Z"),
  });

  console.log(result);
}

run();

Report usage

Send meter events to record consumption once a subscription is active. The endpoint is fire-and-forget — it always returns 202 Accepted.

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.events.ingest({
    type: "ai.inference",
    source: "https://api.myapp.com",
    subject: "cus_abc123",
    data: {
      "tokens": 1500,
      "model": "gpt-4o",
    },
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
bearerAuth http HTTP Bearer PAYGENTIC_BEARER_AUTH

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.billableMetrics.create({
    aggregation: "SUM",
    description: "Tracks total tokens consumed per API call.",
    merchantId: "org_YS8jkP59V71TdUvj",
    name: "Token Counter",
    productId: "prod_abc123",
    unit: "tokens",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Approvals

BillableMetrics

BillingSchedules

Costs

Customers

Entitlements

  • list - List Entitlements
  • issue - Issue Entitlement
  • get - Get Entitlement

Entitlements.Grants

Events

ExternalReferences

Features

Fees

InvoicesV2

Items

MerchantIntegrations

Orders

PaymentSessions

Payments

Plans

Prices

Products

Profitability

Revenue

  • get - Get revenue summary

Salesforce

Sources

Sources.Events

Sources.Rules

Subscriptions

TestClocks

Users

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.billableMetrics.create({
    aggregation: "SUM",
    description: "Tracks total tokens consumed per API call.",
    merchantId: "org_YS8jkP59V71TdUvj",
    name: "Token Counter",
    productId: "prod_abc123",
    unit: "tokens",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.billableMetrics.create({
    aggregation: "SUM",
    description: "Tracks total tokens consumed per API call.",
    merchantId: "org_YS8jkP59V71TdUvj",
    name: "Token Counter",
    productId: "prod_abc123",
    unit: "tokens",
  });

  console.log(result);
}

run();

Error Handling

PaygenticError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Paygentic } from "@paygentic/sdk";
import * as errors from "@paygentic/sdk/models/errors";

const paygentic = new Paygentic({
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await paygentic.billableMetrics.create({
      aggregation: "SUM",
      description: "Tracks total tokens consumed per API call.",
      merchantId: "org_YS8jkP59V71TdUvj",
      name: "Token Counter",
      productId: "prod_abc123",
      unit: "tokens",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.PaygenticError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // string
        console.log(error.data$.message); // string
        console.log(error.data$.code); // string
        console.log(error.data$.details); // { [k: string]: any }
      }
    }
  }
}

run();

Error Classes

Primary errors:

Less common errors (11)

Network errors:

Inherit from PaygenticError:

  • ValidationError: Bad Request - The request could not be understood or was missing required parameters. Status code 400. Applicable to 90 of 139 methods.*
  • DeleteCustomerConflictError: Customer cannot be deleted due to active dependencies. Status code 409. Applicable to 1 of 139 methods.*
  • DeleteFeeConflictError: Fee cannot be deleted because it has associated prices. Status code 409. Applicable to 1 of 139 methods.*
  • UpdatePriceConflictError: Price cannot be restructured because a subscription still bills it directly. Status code 409. Applicable to 1 of 139 methods.*
  • DeletePriceConflictError: Price cannot be deleted because a live plan still references it. Status code 409. Applicable to 1 of 139 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Description
0 https://api.paygentic.io Production API
1 https://api.sandbox.paygentic.io Sandbox API

Example

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  serverIdx: 0,
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.billableMetrics.create({
    aggregation: "SUM",
    description: "Tracks total tokens consumed per API call.",
    merchantId: "org_YS8jkP59V71TdUvj",
    name: "Token Counter",
    productId: "prod_abc123",
    unit: "tokens",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Paygentic } from "@paygentic/sdk";

const paygentic = new Paygentic({
  serverURL: "https://api.sandbox.paygentic.io",
  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await paygentic.billableMetrics.create({
    aggregation: "SUM",
    description: "Tracks total tokens consumed per API call.",
    merchantId: "org_YS8jkP59V71TdUvj",
    name: "Token Counter",
    productId: "prod_abc123",
    unit: "tokens",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Paygentic } from "@paygentic/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@paygentic/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Paygentic({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Paygentic } from "@paygentic/sdk";

const sdk = new Paygentic({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable PAYGENTIC_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

Node sdk for using the paygentic API

Resources

Readme
MIT license

Contributing

Contributing
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages