orb-billing 2.2.0 → 2.4.0

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

@@ -14,18 +14,21 @@ export class Credits extends APIResource {
 
   /**
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
+   *
+   * Note that `currency` defaults to credits if not specified. To use a real world
+   * currency, set `currency` to an ISO 4217 string.
    */
   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> {
@@ -40,18 +43,21 @@ export class Credits extends APIResource {
 
   /**
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
+   *
+   * Note that `currency` defaults to credits if not specified. To use a real world
+   * currency, set `currency` to an ISO 4217 string.
    */
   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 +81,8 @@ export interface CreditListResponse {
 
   balance: number;
 
+  effective_date: string | null;
+
   expiry_date: string | null;
 
   per_unit_cost_basis: string | null;
@@ -87,6 +95,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> {
@@ -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;
     }
   }
 
@@ -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/events/backfills.ts

@@ -116,6 +116,11 @@ export interface BackfillCreateResponse {
    */
   customer_id: string | null;
 
+  /**
+   * The number of events ingested in this backfill.
+   */
+  events_ingested: number;
+
   /**
    * The time at which this backfill was reverted.
    */
@@ -152,6 +157,11 @@ export interface BackfillListResponse {
    */
   customer_id: string | null;
 
+  /**
+   * The number of events ingested in this backfill.
+   */
+  events_ingested: number;
+
   /**
    * The time at which this backfill was reverted.
    */
@@ -188,6 +198,11 @@ export interface BackfillCloseResponse {
    */
   customer_id: string | null;
 
+  /**
+   * The number of events ingested in this backfill.
+   */
+  events_ingested: number;
+
   /**
    * The time at which this backfill was reverted.
    */
@@ -224,6 +239,11 @@ export interface BackfillFetchResponse {
    */
   customer_id: string | null;
 
+  /**
+   * The number of events ingested in this backfill.
+   */
+  events_ingested: number;
+
   /**
    * The time at which this backfill was reverted.
    */
@@ -260,6 +280,11 @@ export interface BackfillRevertResponse {
    */
   customer_id: string | null;
 
+  /**
+   * The number of events ingested in this backfill.
+   */
+  events_ingested: number;
+
   /**
    * The time at which this backfill was reverted.
    */

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,

package/src/resources/invoices.ts

@@ -69,7 +69,7 @@ export class Invoices extends APIResource {
 
   /**
    * This endpoint allows an eligible invoice to be issued manually. This is only
-   * possible with invoices where status is `draft`, `will_auto_issue` is true, and
+   * possible with invoices where status is `draft`, `will_auto_issue` is false, and
    * an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
    * possibly trigger side effects, some of which could be customer-visible (e.g.
    * sending emails, auto-collecting payment, syncing the invoice to external

package/src/resources/plans/plans.ts

@@ -373,6 +373,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -431,6 +442,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -459,7 +481,7 @@ export namespace PlanCreateParams {
        * An integer amount to represent package size. For example, 1000 here would divide
        * usage by 1000 before multiplying by package_amount in rating
        */
-      package_size?: number | null;
+      package_size: number;
     }
   }
 
@@ -495,6 +517,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -579,6 +612,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -656,6 +700,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -739,6 +794,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -802,6 +868,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -880,6 +957,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -952,6 +1040,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -1001,6 +1100,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -1050,6 +1160,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -1099,6 +1220,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */
@@ -1148,6 +1280,17 @@ export namespace PlanCreateParams {
      */
     billed_in_advance?: boolean | null;
 
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
     /**
      * An alias for the price.
      */