Apollo Billing API SDK

Central billing API for Apollo Deploy internal applications. Provides checkout, entitlement resolution, billing enforcement, usage ingestion, customer billing management, and Polar webhook handling.

Generated by Tesseract. Generated source files should not be edited manually.

Installation

npm install @apollo-deploy/billing-sdk

Quick start

import { createApolloBillingClient } from '@apollo-deploy/billing-sdk';

const client = createApolloBillingClient({
  baseUrl: 'https://billing.apollodeploy.com',
  timeoutMs: 15_000,
});

// Domain clients are available directly on the client.
const api = client.health;

Configuration and reliability

The generated transport supports:

• Bounded request timeouts and AbortSignal cancellation
• Exponential-backoff retries for transient failures
• Retry-After handling for rate limits
• Per-request headers, timeout, and retry overrides
• Structured SDKError values with HTTP status, error code, and request ID
• Request/response hooks and transport plugins for logging or telemetry

const client = createApolloBillingClient({
  timeoutMs: 30_000,
  defaultHeaders: { 'X-Application': 'my-service' },
  retries: {
    attempts: 3,
    backoffMs: 400,
    jitter: true,
  },
});

Mutating requests are retried only when the request is considered idempotent, carries an idempotency key, or the retry policy explicitly allows it.

Documentation

• Documentation index
• Generated types

| Domain | Description | |---|---| | HealthAPI | health operations | | CatalogAPI | catalog operations | | EnforcementAPI | enforcement operations | | EntitlementsAPI | entitlements operations | | CheckoutAPI | checkout operations | | CustomerBillingAPI | customerBilling operations | | UsageAPI | usage operations | | SubscriptionsAPI | subscriptions operations | | InvoicesAPI | invoices operations |

Error handling

import { SDKError } from '@apollo-deploy/billing-sdk';

try {
  // await client.someDomain.someOperation();
} catch (error) {
  if (error instanceof SDKError) {
    console.error(error.status, error.code, error.requestId);
  }
  throw error;
}

License

MIT