orb-billing

orb-billing

SDK Installation

NPM

npm add orb-billing

Yarn

yarn add orb-billing

SDK Example Usage

import { Orb } from "orb-billing";

(async() => {
  const sdk = new Orb({
    security: {
      apiKey: "",
    },
  });

  const res = await sdk.availability.ping();

  if (res.statusCode == 200) {
    // handle response
  }
})();

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a next method that can be called to pull down the next group of results. If the return value of next is null, then there are no more pages to be fetched.

Here's an example of one such pagination call:

/* eslint-disable prefer-const */
import { Orb } from "orb-billing";

// Initialize the SDK with an API key.
const sdk = new Orb({
  security: {
    apiKeyAuth: "",
  },
});

async function paginationDemo() {
  let cursor: string | undefined;

  // We start by attempting to fetch at least one page of results.
  do {
    // The SDK call takes the cursor and any additional arguments to filter the
    // coupon data.
    const response = await sdk.coupon.list({ cursor, showArchived: false });
    const { statusCode } = response;
    if (statusCode !== 200) {
      throw new Error(`Unexpected status code sent from server: ${statusCode}`);
    }

    // We capture the cursor for the next iteration but we also check if we
    // received an empty page of results as a signal to stop making additional
    // requests.
    cursor = response.coupons?.paginationMetadata.nextCursor;
    const page = response.coupons?.data;
    if (!page?.length) {
      break;
    }

    // At this point we have a page of coupon entries that we can collect or
    // iterate through as shown below.
    page.forEach((coupon) => {
      const { redemptionCode: code, timesRedeemed } = coupon;
      console.log(`Coupon ${code} was redeemed ${timesRedeemed} times.`);
    });

    // The loop will continue if we received a cursor for additional results.
  } while (cursor);
}

// Run the demo function.
paginationDemo();

Available Resources and Operations

availability

• ping - Check availability

coupon

• archive - Archive coupon
• create - Create coupon
• fetch - Fetch coupon
• list - List coupons
• listSubscriptions - List coupon subscriptions

credit

• addByExternalId - Create ledger entry by external ID
• create - Create ledger entry
• fetchBalance - Fetch customer credit balance
• fetchBalanceByExternalId - Fetch customer credit balance by external customer id
• fetchLedger - Fetch customer credits ledger
• fetchLedgerByExternalId - Fetch customer credits ledger by external ID

creditNote

• fetch - Fetch credit note
• list - List credit notes

customer

• amend - Amend usage
• amendByExternalId - Amend usage by external ID
• create - Create customer
• createBalanceTransaction - Create customer balance transaction
• delete - Delete customer
• fetch - Fetch customer
• fetchByExternalId - Fetch customer by external ID
• fetchCosts - Fetch customer costs
• fetchCostsByExternalId - Fetch customer costs by external ID
• list - List customers
• listBalanceTransactions - List balance transactions
• updateByExternalId - Update customer by external ID
• updateCustomer - Update customer

event

• amend - Amend event
• closeBackfill - Close backfill
• create - Create backfill
• deprecateEvent - Deprecate event
• fetch - Fetch backfill
• ingest - Ingest events
• listBackfills - List backfills
• revertBackfill - Revert backfill
• search - Search events

invoice

• create - Create a one-off invoice
• createLineItem - Create invoice line item
• fetch - Fetch invoice
• fetchUpcoming - Fetch upcoming invoice
• issue - Issue invoice
• list - List invoices
• markInvoiceAsPaid - Mark invoice as paid
• void - Void invoice

item

• fetch - Fetch item
• list - List items

metric

• create - Create metric
• fetch - Get metric
• list - List metrics

plan

• create - Create plan
• fetch - Fetch plan
• fetchByExternalId - Fetch plan by external ID
• list - List plans
• updatePlan - Update plan by id
• updatePlanExternal - Update plan by external ID

price

• create - Create price
• fetch - Fetch price
• fetchByExternalId - Fetch price by external price id
• list - List prices

priceInterval

• addEditPriceIntervals - Add or edit price intervals

subscription

• cancel - Cancel subscription
• create - Create subscription
• fetch - Fetch subscription
• fetchCosts - Fetch subscription costs
• fetchSchedule - Fetch subscription schedule
• fetchUsage - Fetch subscription usage
• list - List subscriptions
• schedulePlanChange - Schedule plan change
• triggerPhase - Trigger phase
• unscheduleCancellation - Unschedule subscription cancellation
• unscheduleFixedFeeQuantity - Unschedule fixed fee quantity updates
• unschedulePlanChange - Unschedule plan change
• updateFixedFeeQuantity - Update price quantity

Dev Containers

Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!

• Explore Dev Containers

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy