orb-billing

orb-billing

SDK Installation

NPM

npm add orb-billing

Yarn

yarn add orb-billing

SDK Example Usage

import { Orb } from "orb-billing";
import { CreateCustomerResponse } from "orb-billing/dist/sdk/models/operations";
import { CustomerPaymentProvider, NewCustomerPaymentProvider } from "orb-billing/dist/sdk/models/shared";

const sdk = new Orb({
  security: {
    apiKeyAuth: "",
  },
});

sdk.customer.create({
  autoCollection: false,
  billingAddress: {
    city: "Laruecester",
    country: "US",
    line1: "quibusdam",
    line2: "unde",
    postalCode: "58466-3428",
    state: "ipsa",
  },
  currency: "delectus",
  email: "[e-mail]",
  externalCustomerId: "iusto",
  metadata: {},
  name: "Charlie Walsh II",
  paymentProvider: NewCustomerPaymentProvider.Quickbooks,
  paymentProviderId: "deserunt",
  shippingAddress: {
    city: "West Ritaworth",
    country: "US",
    line1: "quo",
    line2: "odit",
    postalCode: "89478-4576",
    state: "dicta",
  },
  taxId: {
    country: "Puerto Rico",
    type: "officia",
    value: "occaecati",
  },
  timezone: "Etc/UTC",
}).then((res: CreateCustomerResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

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
• fetch - Fetch customer credit balance
• fetchByExternalId - Fetch customer credit balance by external customer id
• fetchLedger - Fetch customer credits ledger
• fetchLedgerExternalId - Fetch 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
• fetchTransactions - List balance transactions
• list - List customers
• updateByExternalId - Update customer by external ID
• updateCustomer - Update customer

event

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

invoice

• create - Create invoice line item
• fetch - Fetch invoice
• fetchUpcoming - Fetch upcoming invoice
• issue - Issue an invoice
• list - List invoices
• void - Void invoice

plan

• fetch - Fetch plan
• getByExternalId - Fetch plan by external ID
• list - List plans

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
• unscheduleCancellation - Unschedule subscription cancellation
• unschedulePlanChange - Unschedule plan change
• updateFixedFeeQuantity - Update price quantity

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