@paygentic/sdk 0.6.33 → 0.6.34

package/FUNCTIONS.md

@@ -20,7 +20,7 @@ specific category of applications.
 
 ```typescript
 import { PaygenticCore } from "@paygentic/sdk/core.js";
-import { billableMetricsCreate } from "@paygentic/sdk/funcs/billableMetricsCreate.js";
+import { customersCreate } from "@paygentic/sdk/funcs/customersCreate.js";
 
 // Use `PaygenticCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -29,19 +29,23 @@ const paygentic = new PaygenticCore({
 });
 
 async function run() {
-  const res = await billableMetricsCreate(paygentic, {
-    aggregation: "SUM",
-    description: "other gracefully hold",
-    merchantId: "<id>",
-    name: "<value>",
-    productId: "<id>",
-    unit: "becquerel",
+  const res = await customersCreate(paygentic, {
+    consumer: {
+      name: "Jane Smith",
+      email: "jane@example.com",
+      address: {
+        city: "San Francisco",
+        state: "CA",
+        country: "US",
+      },
+    },
+    merchantId: "org_YS8jkP59V71TdUvj",
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("billableMetricsCreate failed:", res.error);
+    console.log("customersCreate failed:", res.error);
   }
 }
 

package/README.md

@@ -14,31 +14,19 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
 <!-- Start Summary [summary] -->
 ## Summary
 
-Paygentic API: The Paygentic API provides a comprehensive platform for building and scaling monetization infrastructure.
+Paygentic API: The Paygentic API provides billing infrastructure for usage-based and subscription monetization — customers, subscriptions, usage metering, invoicing, entitlements, and payments.
 
-## Authentication
-All API requests require authentication using an API key passed in the `Authorization` header:
-```
-Authorization: Bearer YOUR_API_KEY
-```
-
-## Base URL
-All API requests should be made to:
-```
-https://api.paygentic.io/v0
-```
+See the [Quickstart](https://docs.paygentic.io/getting-started/quickstart) to go from zero to billing in four steps.
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
 * [paygentic](#paygentic)
-  * [Authentication](#authentication)
-  * [Base URL](#base-url)
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
   * [SDK Example Usage](#sdk-example-usage)
-  * [Authentication](#authentication-1)
+  * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
   * [Retries](#retries)
@@ -55,30 +43,34 @@ https://api.paygentic.io/v0
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+> [!TIP]
+> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
+
+
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add @paygentic/sdk
+npm add https://github.com/paygentic/sdk-node
 ```
 
 ### PNPM
 
 ```bash
-pnpm add @paygentic/sdk
+pnpm add https://github.com/paygentic/sdk-node
 ```
 
 ### Bun
 
 ```bash
-bun add @paygentic/sdk
+bun add https://github.com/paygentic/sdk-node
 ```
 
 ### Yarn
 
 ```bash
-yarn add @paygentic/sdk
+yarn add https://github.com/paygentic/sdk-node
 ```
 
 > [!NOTE]
@@ -94,7 +86,9 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
 
-### Example
+### Create a customer
+
+Create a customer for each organization you bill. This is the first step in the billing setup — see the [Quickstart](https://docs.paygentic.io/getting-started/quickstart) for the full flow.
 
 ```typescript
 import { Paygentic } from "@paygentic/sdk";
@@ -104,13 +98,72 @@ const paygentic = new Paygentic({
 });
 
 async function run() {
-  const result = await paygentic.billableMetrics.create({
-    aggregation: "SUM",
-    description: "other gracefully hold",
-    merchantId: "<id>",
-    name: "<value>",
-    productId: "<id>",
-    unit: "becquerel",
+  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.
+
+```typescript
+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`.
+
+```typescript
+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);
@@ -143,11 +196,11 @@ const paygentic = new Paygentic({
 async function run() {
   const result = await paygentic.billableMetrics.create({
     aggregation: "SUM",
-    description: "other gracefully hold",
-    merchantId: "<id>",
-    name: "<value>",
-    productId: "<id>",
-    unit: "becquerel",
+    description: "Tracks total tokens consumed per API call",
+    merchantId: "org_YS8jkP59V71TdUvj",
+    name: "Token Counter",
+    productId: "prod_abc123",
+    unit: "tokens",
   });
 
   console.log(result);
@@ -461,11 +514,11 @@ const paygentic = new Paygentic({
 async function run() {
   const result = await paygentic.billableMetrics.create({
     aggregation: "SUM",
-    description: "other gracefully hold",
-    merchantId: "<id>",
-    name: "<value>",
-    productId: "<id>",
-    unit: "becquerel",
+    description: "Tracks total tokens consumed per API call",
+    merchantId: "org_YS8jkP59V71TdUvj",
+    name: "Token Counter",
+    productId: "prod_abc123",
+    unit: "tokens",
   }, {
     retries: {
       strategy: "backoff",
@@ -507,11 +560,11 @@ const paygentic = new Paygentic({
 async function run() {
   const result = await paygentic.billableMetrics.create({
     aggregation: "SUM",
-    description: "other gracefully hold",
-    merchantId: "<id>",
-    name: "<value>",
-    productId: "<id>",
-    unit: "becquerel",
+    description: "Tracks total tokens consumed per API call",
+    merchantId: "org_YS8jkP59V71TdUvj",
+    name: "Token Counter",
+    productId: "prod_abc123",
+    unit: "tokens",
   });
 
   console.log(result);
@@ -549,11 +602,11 @@ async function run() {
   try {
     const result = await paygentic.billableMetrics.create({
       aggregation: "SUM",
-      description: "other gracefully hold",
-      merchantId: "<id>",
-      name: "<value>",
-      productId: "<id>",
-      unit: "becquerel",
+      description: "Tracks total tokens consumed per API call",
+      merchantId: "org_YS8jkP59V71TdUvj",
+      name: "Token Counter",
+      productId: "prod_abc123",
+      unit: "tokens",
     });
 
     console.log(result);
@@ -624,11 +677,11 @@ const paygentic = new Paygentic({
 async function run() {
   const result = await paygentic.billableMetrics.create({
     aggregation: "SUM",
-    description: "other gracefully hold",
-    merchantId: "<id>",
-    name: "<value>",
-    productId: "<id>",
-    unit: "becquerel",
+    description: "Tracks total tokens consumed per API call",
+    merchantId: "org_YS8jkP59V71TdUvj",
+    name: "Token Counter",
+    productId: "prod_abc123",
+    unit: "tokens",
   });
 
   console.log(result);

package/dist/commonjs/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "0.1.0";
-    readonly sdkVersion: "0.6.32";
+    readonly sdkVersion: "0.6.34";
     readonly genVersion: "2.879.13";
-    readonly userAgent: "speakeasy-sdk/typescript 0.6.32 2.879.13 0.1.0 @paygentic/sdk";
+    readonly userAgent: "speakeasy-sdk/typescript 0.6.34 2.879.13 0.1.0 @paygentic/sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/commonjs/lib/config.js

@@ -31,8 +31,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.1.0",
-    sdkVersion: "0.6.32",
+    sdkVersion: "0.6.34",
     genVersion: "2.879.13",
-    userAgent: "speakeasy-sdk/typescript 0.6.32 2.879.13 0.1.0 @paygentic/sdk",
+    userAgent: "speakeasy-sdk/typescript 0.6.34 2.879.13 0.1.0 @paygentic/sdk",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "0.1.0";
-    readonly sdkVersion: "0.6.32";
+    readonly sdkVersion: "0.6.34";
     readonly genVersion: "2.879.13";
-    readonly userAgent: "speakeasy-sdk/typescript 0.6.32 2.879.13 0.1.0 @paygentic/sdk";
+    readonly userAgent: "speakeasy-sdk/typescript 0.6.34 2.879.13 0.1.0 @paygentic/sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -27,8 +27,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.1.0",
-    sdkVersion: "0.6.32",
+    sdkVersion: "0.6.34",
     genVersion: "2.879.13",
-    userAgent: "speakeasy-sdk/typescript 0.6.32 2.879.13 0.1.0 @paygentic/sdk",
+    userAgent: "speakeasy-sdk/typescript 0.6.34 2.879.13 0.1.0 @paygentic/sdk",
 };
 //# sourceMappingURL=config.js.map

package/examples/customersCreate.example.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @paygentic/sdk SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx customersCreate.example.ts
+ */
+
+import { Paygentic } from "@paygentic/sdk";
+
+const paygentic = new Paygentic({
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function main() {
+  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);
+}
+
+main().catch(console.error);

package/jsr.json

@@ -1,10 +1,12 @@
+
+
 {
   "name": "@paygentic/sdk",
-  "version": "0.6.33",
+  "version": "0.6.34",
   "exports": {
-    ".": "./src/index.ts",
-    "./models/errors": "./src/models/errors/index.ts",
-    "./models": "./src/models/index.ts",
+    ".": "./src/index.ts",    
+    "./models/errors": "./src/models/errors/index.ts",    
+    "./models": "./src/models/index.ts",    
     "./models/operations": "./src/models/operations/index.ts",
     "./lib/config": "./src/lib/config.ts",
     "./lib/http": "./src/lib/http.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paygentic/sdk",
-  "version": "0.6.33",
+  "version": "0.6.34",
   "author": "Speakeasy",
   "repository": {
     "type": "git",

package/src/lib/config.ts

@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.6.32",
+  sdkVersion: "0.6.34",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.6.32 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.6.34 2.879.13 0.1.0 @paygentic/sdk",
 } as const;