orb-billing 2.1.2 → 2.3.0

package/src/index.ts

@@ -14,6 +14,11 @@ export interface ClientOptions {
    */
   apiKey?: string | undefined;
 
+  /**
+   * Defaults to process.env['ORB_WEBHOOK_SECRET'].
+   */
+  webhookSecret?: string | null | undefined;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -74,6 +79,7 @@ export interface ClientOptions {
 /** API Client for interfacing with the Orb API. */
 export class Orb extends Core.APIClient {
   apiKey: string;
+  webhookSecret: string | null;
 
   private _options: ClientOptions;
 
@@ -81,6 +87,7 @@ export class Orb extends Core.APIClient {
    * API Client for interfacing with the Orb API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
+   * @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
    * @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -92,6 +99,7 @@ export class Orb extends Core.APIClient {
   constructor({
     baseURL = Core.readEnv('ORB_BASE_URL'),
     apiKey = Core.readEnv('ORB_API_KEY'),
+    webhookSecret = Core.readEnv('ORB_WEBHOOK_SECRET') ?? null,
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
@@ -102,6 +110,7 @@ export class Orb extends Core.APIClient {
 
     const options: ClientOptions = {
       apiKey,
+      webhookSecret,
       ...opts,
       baseURL: baseURL || `https://api.withorb.com/v1`,
     };
@@ -117,6 +126,7 @@ export class Orb extends Core.APIClient {
     this.idempotencyHeader = 'Idempotency-Key';
 
     this.apiKey = apiKey;
+    this.webhookSecret = webhookSecret;
   }
 
   topLevel: API.TopLevel = new API.TopLevel(this);
@@ -131,7 +141,7 @@ export class Orb extends Core.APIClient {
   plans: API.Plans = new API.Plans(this);
   prices: API.Prices = new API.Prices(this);
   subscriptions: API.Subscriptions = new API.Subscriptions(this);
-  beta: API.Beta = new API.Beta(this);
+  webhooks: API.Webhooks = new API.Webhooks(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -179,6 +189,9 @@ export class Orb extends Core.APIClient {
   static OrbInternalServerError = Errors.OrbInternalServerError;
   static UnprocessableEntityError = Errors.UnprocessableEntityError;
   static DuplicateResourceCreation = Errors.DuplicateResourceCreation;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
 }
 
 export const {
@@ -213,10 +226,6 @@ export import toFile = Uploads.toFile;
 export import fileFromPath = Uploads.fileFromPath;
 
 export namespace Orb {
-  // Helper functions
-  export import toFile = Uploads.toFile;
-  export import fileFromPath = Uploads.fileFromPath;
-
   export import RequestOptions = Core.RequestOptions;
 
   export import Page = Pagination.Page;
@@ -289,10 +298,13 @@ export namespace Orb {
   export import PlanListParams = API.PlanListParams;
 
   export import Prices = API.Prices;
+  export import EvaluatePriceGroup = API.EvaluatePriceGroup;
   export import Price = API.Price;
+  export import PriceEvaluateResponse = API.PriceEvaluateResponse;
   export import PricesPage = API.PricesPage;
   export import PriceCreateParams = API.PriceCreateParams;
   export import PriceListParams = API.PriceListParams;
+  export import PriceEvaluateParams = API.PriceEvaluateParams;
 
   export import Subscriptions = API.Subscriptions;
   export import Subscription = API.Subscription;
@@ -302,6 +314,7 @@ export namespace Orb {
   export import SubscriptionsPage = API.SubscriptionsPage;
   export import SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
   export import SubscriptionCreateParams = API.SubscriptionCreateParams;
+  export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
   export import SubscriptionListParams = API.SubscriptionListParams;
   export import SubscriptionCancelParams = API.SubscriptionCancelParams;
   export import SubscriptionFetchCostsParams = API.SubscriptionFetchCostsParams;
@@ -313,9 +326,9 @@ export namespace Orb {
   export import SubscriptionUnscheduleFixedFeeQuantityUpdatesParams = API.SubscriptionUnscheduleFixedFeeQuantityUpdatesParams;
   export import SubscriptionUpdateFixedFeeQuantityParams = API.SubscriptionUpdateFixedFeeQuantityParams;
 
-  export import Beta = API.Beta;
-
+  export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
   export import Discount = API.Discount;
+  export import PaginationMetadata = API.PaginationMetadata;
 }
 
 export default Orb;

package/src/resources/coupons/coupons.ts

@@ -144,7 +144,7 @@ export namespace Coupon {
 }
 
 export interface CouponCreateParams {
-  discount: CouponCreateParams.PercentageDiscount | CouponCreateParams.AmountDiscount;
+  discount: CouponCreateParams.NewCouponPercentageDiscount | CouponCreateParams.NewCouponAmountDiscount;
 
   /**
    * This string can be used to redeem this coupon for a given subscription.
@@ -165,39 +165,16 @@ export interface CouponCreateParams {
 }
 
 export namespace CouponCreateParams {
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
+  export interface NewCouponPercentageDiscount {
     discount_type: 'percentage';
 
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
     percentage_discount: number;
-
-    reason?: string | null;
   }
 
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
+  export interface NewCouponAmountDiscount {
     amount_discount: string;
 
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
     discount_type: 'amount';
-
-    reason?: string | null;
   }
 }
 

package/src/resources/customers/costs.ts

@@ -144,13 +144,13 @@ export class Costs extends APIResource {
    * `grouping_value` and `secondary_grouping_value` available.
    */
   list(
-    customerId: string | null,
+    customerId: string,
     query?: CostListParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListResponse>;
-  list(customerId: string | null, options?: Core.RequestOptions): Core.APIPromise<CostListResponse>;
+  list(customerId: string, options?: Core.RequestOptions): Core.APIPromise<CostListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     query: CostListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListResponse> {
@@ -297,16 +297,16 @@ export class Costs extends APIResource {
    * `grouping_value` and `secondary_grouping_value` available.
    */
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query?: CostListByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query: CostListByExternalIDParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListByExternalIDResponse> {

package/src/resources/customers/credits/credits.ts

@@ -16,16 +16,16 @@ export class Credits extends APIResource {
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
    */
   list(
-    customerId: string | null,
+    customerId: string,
     query?: CreditListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     query: CreditListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListResponsesPage, CreditListResponse> {
@@ -42,16 +42,16 @@ export class Credits extends APIResource {
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
    */
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query?: CreditListByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query: CreditListByExternalIDParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse> {
@@ -75,6 +75,8 @@ export interface CreditListResponse {
 
   balance: number;
 
+  effective_date: string | null;
+
   expiry_date: string | null;
 
   per_unit_cost_basis: string | null;
@@ -87,6 +89,8 @@ export interface CreditListByExternalIDResponse {
 
   balance: number;
 
+  effective_date: string | null;
+
   expiry_date: string | null;
 
   per_unit_cost_basis: string | null;

package/src/resources/customers/credits/ledger.ts

@@ -91,16 +91,16 @@ export class Ledger extends APIResource {
    * entry will be added to the ledger to indicate the adjustment of credits.
    */
   list(
-    customerId: string | null,
+    customerId: string,
     query?: LedgerListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<LedgerListResponsesPage, LedgerListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<LedgerListResponsesPage, LedgerListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     query: LedgerListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<LedgerListResponsesPage, LedgerListResponse> {
@@ -225,7 +225,7 @@ export class Ledger extends APIResource {
    * return to the customer, up to the block's initial balance.
    */
   createEntry(
-    customerId: string | null,
+    customerId: string,
     body: LedgerCreateEntryParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<LedgerCreateEntryResponse> {
@@ -344,7 +344,7 @@ export class Ledger extends APIResource {
    * return to the customer, up to the block's initial balance.
    */
   createEntryByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     body: LedgerCreateEntryByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<LedgerCreateEntryByExternalIDResponse> {
@@ -438,16 +438,16 @@ export class Ledger extends APIResource {
    * entry will be added to the ledger to indicate the adjustment of credits.
    */
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query?: LedgerListByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<LedgerListByExternalIDResponsesPage, LedgerListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<LedgerListByExternalIDResponsesPage, LedgerListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query: LedgerListByExternalIDParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<LedgerListByExternalIDResponsesPage, LedgerListByExternalIDResponse> {
@@ -2084,8 +2084,8 @@ export namespace LedgerCreateEntryParams {
     metadata?: Record<string, string | null> | null;
 
     /**
-     * Can only be specified when entry_type=increment. How much, in USD, a customer
-     * paid for a single credit in this block
+     * Can only be specified when entry_type=increment. How much, in the customer's
+     * currency, a customer paid for a single credit in this block
      */
     per_unit_cost_basis?: string | null;
   }
@@ -2115,6 +2115,12 @@ export namespace LedgerCreateEntryParams {
        * An optional memo to display on the invoice.
        */
       memo?: string | null;
+
+      /**
+       * If true, the new credit block will require that the corresponding invoice is
+       * paid before it can be drawn down from.
+       */
+      require_successful_payment?: boolean;
     }
   }
 
@@ -2329,8 +2335,8 @@ export namespace LedgerCreateEntryByExternalIDParams {
     metadata?: Record<string, string | null> | null;
 
     /**
-     * Can only be specified when entry_type=increment. How much, in USD, a customer
-     * paid for a single credit in this block
+     * Can only be specified when entry_type=increment. How much, in the customer's
+     * currency, a customer paid for a single credit in this block
      */
     per_unit_cost_basis?: string | null;
   }
@@ -2360,6 +2366,12 @@ export namespace LedgerCreateEntryByExternalIDParams {
        * An optional memo to display on the invoice.
        */
       memo?: string | null;
+
+      /**
+       * If true, the new credit block will require that the corresponding invoice is
+       * paid before it can be drawn down from.
+       */
+      require_successful_payment?: boolean;
     }
   }
 

package/src/resources/customers/credits/top-ups.ts

@@ -17,7 +17,7 @@ export class TopUps extends APIResource {
    * top-up will be replaced.
    */
   create(
-    customerId: string | null,
+    customerId: string,
     body: TopUpCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TopUpCreateResponse> {
@@ -28,16 +28,16 @@ export class TopUps extends APIResource {
    * List top-ups
    */
   list(
-    customerId: string | null,
+    customerId: string,
     query?: TopUpListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<TopUpListResponsesPage, TopUpListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<TopUpListResponsesPage, TopUpListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     query: TopUpListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<TopUpListResponsesPage, TopUpListResponse> {
@@ -53,7 +53,7 @@ export class TopUps extends APIResource {
   /**
    * Delete top-up
    */
-  delete(customerId: string | null, topUpId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+  delete(customerId: string, topUpId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/customers/${customerId}/credits/top_ups/${topUpId}`, {
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -70,7 +70,7 @@ export class TopUps extends APIResource {
    * top-up will be replaced.
    */
   createByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     body: TopUpCreateByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TopUpCreateByExternalIDResponse> {
@@ -84,7 +84,7 @@ export class TopUps extends APIResource {
    * Delete top-up by external ID
    */
   deleteByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     topUpId: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<void> {
@@ -98,16 +98,16 @@ export class TopUps extends APIResource {
    * List top-ups by external ID
    */
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query?: TopUpListByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<TopUpListByExternalIDResponsesPage, TopUpListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<TopUpListByExternalIDResponsesPage, TopUpListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query: TopUpListByExternalIDParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<TopUpListByExternalIDResponsesPage, TopUpListByExternalIDResponse> {
@@ -190,6 +190,12 @@ export namespace TopUpCreateResponse {
      * An optional memo to display on the invoice.
      */
     memo?: string | null;
+
+    /**
+     * If true, new credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they can be drawn down from.
+     */
+    require_successful_payment?: boolean;
   }
 }
 
@@ -257,6 +263,12 @@ export namespace TopUpListResponse {
      * An optional memo to display on the invoice.
      */
     memo?: string | null;
+
+    /**
+     * If true, new credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they can be drawn down from.
+     */
+    require_successful_payment?: boolean;
   }
 }
 
@@ -324,6 +336,12 @@ export namespace TopUpCreateByExternalIDResponse {
      * An optional memo to display on the invoice.
      */
     memo?: string | null;
+
+    /**
+     * If true, new credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they can be drawn down from.
+     */
+    require_successful_payment?: boolean;
   }
 }
 
@@ -391,6 +409,12 @@ export namespace TopUpListByExternalIDResponse {
      * An optional memo to display on the invoice.
      */
     memo?: string | null;
+
+    /**
+     * If true, new credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they can be drawn down from.
+     */
+    require_successful_payment?: boolean;
   }
 }
 
@@ -456,6 +480,12 @@ export namespace TopUpCreateParams {
      * An optional memo to display on the invoice.
      */
     memo?: string | null;
+
+    /**
+     * If true, new credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they can be drawn down from.
+     */
+    require_successful_payment?: boolean;
   }
 }
 
@@ -523,6 +553,12 @@ export namespace TopUpCreateByExternalIDParams {
      * An optional memo to display on the invoice.
      */
     memo?: string | null;
+
+    /**
+     * If true, new credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they can be drawn down from.
+     */
+    require_successful_payment?: boolean;
   }
 }
 

package/src/resources/customers/usage.ts

@@ -104,7 +104,7 @@ export class Usage extends APIResource {
    * using multiple calls with small adjacent (e.g. every hour) timeframes.
    */
   update(
-    id: string | null,
+    id: string,
     params: UsageUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<UsageUpdateResponse> {
@@ -215,7 +215,7 @@ export class Usage extends APIResource {
    * using multiple calls with small adjacent (e.g. every hour) timeframes.
    */
   updateByExternalId(
-    id: string | null,
+    id: string,
     params: UsageUpdateByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<UsageUpdateByExternalIDResponse> {

package/src/resources/index.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
-export { Beta } from './beta/beta';
 export { Coupon, CouponCreateParams, CouponListParams, CouponsPage, Coupons } from './coupons/coupons';
 export { CreditNote, CreditNoteListParams, CreditNotesPage, CreditNotes } from './credit-notes';
 export {
@@ -13,6 +12,16 @@ export {
   CustomersPage,
   Customers,
 } from './customers/customers';
+export {
+  EvaluatePriceGroup,
+  Price,
+  PriceEvaluateResponse,
+  PriceCreateParams,
+  PriceListParams,
+  PriceEvaluateParams,
+  PricesPage,
+  Prices,
+} from './prices/prices';
 export {
   EventUpdateResponse,
   EventDeprecateResponse,
@@ -49,7 +58,6 @@ export {
   Metrics,
 } from './metrics';
 export { Plan, PlanCreateParams, PlanUpdateParams, PlanListParams, PlansPage, Plans } from './plans/plans';
-export { Price, PriceCreateParams, PriceListParams, PricesPage, Prices } from './prices/prices';
 export {
   Subscription,
   SubscriptionUsage,
@@ -57,6 +65,7 @@ export {
   SubscriptionFetchCostsResponse,
   SubscriptionFetchScheduleResponse,
   SubscriptionCreateParams,
+  SubscriptionUpdateParams,
   SubscriptionListParams,
   SubscriptionCancelParams,
   SubscriptionFetchCostsParams,
@@ -71,3 +80,4 @@ export {
   SubscriptionFetchScheduleResponsesPage,
 } from './subscriptions';
 export { TopLevelPingResponse, TopLevel } from './top-level';
+export { Webhooks } from './webhooks';

package/src/resources/invoices.ts

@@ -273,6 +273,8 @@ export interface Invoice {
    */
   invoice_pdf: string | null;
 
+  invoice_source: 'subscription' | 'partial' | 'one_off';
+
   /**
    * If the invoice failed to issue, this will be the last time it failed to issue
    * (even if it is now in a different state.)
@@ -1353,6 +1355,8 @@ export interface InvoiceFetchUpcomingResponse {
    */
   invoice_pdf: string | null;
 
+  invoice_source: 'subscription' | 'partial' | 'one_off';
+
   /**
    * If the invoice failed to issue, this will be the last time it failed to issue
    * (even if it is now in a different state.)