orb-billing 4.32.0 → 4.47.1

package/src/resources/index.ts

@@ -2,95 +2,141 @@
 
 export * from './shared';
 export {
-  Alert,
-  AlertUpdateParams,
-  AlertListParams,
-  AlertCreateForCustomerParams,
-  AlertCreateForExternalCustomerParams,
-  AlertCreateForSubscriptionParams,
   AlertsPage,
   Alerts,
+  type Alert,
+  type AlertUpdateParams,
+  type AlertListParams,
+  type AlertCreateForCustomerParams,
+  type AlertCreateForExternalCustomerParams,
+  type AlertCreateForSubscriptionParams,
+  type AlertDisableParams,
+  type AlertEnableParams,
 } from './alerts';
 export {
-  BillableMetric,
-  MetricCreateParams,
-  MetricUpdateParams,
-  MetricListParams,
   BillableMetricsPage,
   Metrics,
+  type BillableMetric,
+  type MetricCreateParams,
+  type MetricUpdateParams,
+  type MetricListParams,
 } from './metrics';
-export { Coupon, CouponCreateParams, CouponListParams, CouponsPage, Coupons } from './coupons/coupons';
-export { CreditNote, CreditNoteListParams, CreditNotesPage, CreditNotes } from './credit-notes';
 export {
-  Customer,
-  CustomerCreateParams,
-  CustomerUpdateParams,
-  CustomerListParams,
-  CustomerUpdateByExternalIDParams,
+  CouponsPage,
+  Coupons,
+  type Coupon,
+  type CouponCreateParams,
+  type CouponListParams,
+} from './coupons/coupons';
+export {
+  CreditNotesPage,
+  CreditNotes,
+  type CreditNote,
+  type CreditNoteCreateParams,
+  type CreditNoteListParams,
+} from './credit-notes';
+export {
   CustomersPage,
   Customers,
+  type Customer,
+  type CustomerCreateParams,
+  type CustomerUpdateParams,
+  type CustomerListParams,
+  type CustomerUpdateByExternalIDParams,
 } from './customers/customers';
 export {
-  EvaluatePriceGroup,
-  Price,
-  PriceEvaluateResponse,
-  PriceCreateParams,
-  PriceUpdateParams,
-  PriceListParams,
-  PriceEvaluateParams,
-  PricesPage,
-  Prices,
-} from './prices/prices';
+  DimensionalPriceGroupsPage,
+  DimensionalPriceGroups,
+  type DimensionalPriceGroup,
+  type DimensionalPriceGroupCreateParams,
+  type DimensionalPriceGroupListParams,
+} from './dimensional-price-groups/dimensional-price-groups';
 export {
-  EventUpdateResponse,
-  EventDeprecateResponse,
-  EventIngestResponse,
-  EventSearchResponse,
-  EventUpdateParams,
-  EventIngestParams,
-  EventSearchParams,
   Events,
+  type EventUpdateResponse,
+  type EventDeprecateResponse,
+  type EventIngestResponse,
+  type EventSearchResponse,
+  type EventUpdateParams,
+  type EventIngestParams,
+  type EventSearchParams,
 } from './events/events';
 export {
-  Invoice,
-  InvoiceFetchUpcomingResponse,
-  InvoiceCreateParams,
-  InvoiceUpdateParams,
-  InvoiceListParams,
-  InvoiceFetchUpcomingParams,
-  InvoiceIssueParams,
-  InvoiceMarkPaidParams,
+  InvoiceLineItems,
+  type InvoiceLineItemCreateResponse,
+  type InvoiceLineItemCreateParams,
+} from './invoice-line-items';
+export {
   InvoicesPage,
   Invoices,
+  type Invoice,
+  type InvoiceFetchUpcomingResponse,
+  type InvoiceCreateParams,
+  type InvoiceUpdateParams,
+  type InvoiceListParams,
+  type InvoiceFetchUpcomingParams,
+  type InvoiceIssueParams,
+  type InvoiceMarkPaidParams,
 } from './invoices';
 export {
-  InvoiceLineItemCreateResponse,
-  InvoiceLineItemCreateParams,
-  InvoiceLineItems,
-} from './invoice-line-items';
-export { Item, ItemCreateParams, ItemUpdateParams, ItemListParams, ItemsPage, Items } from './items';
-export { Plan, PlanCreateParams, PlanUpdateParams, PlanListParams, PlansPage, Plans } from './plans/plans';
+  ItemsPage,
+  Items,
+  type Item,
+  type ItemCreateParams,
+  type ItemUpdateParams,
+  type ItemListParams,
+} from './items';
+export {
+  PlansPage,
+  Plans,
+  type Plan,
+  type PlanCreateParams,
+  type PlanUpdateParams,
+  type PlanListParams,
+} from './plans/plans';
+export {
+  PricesPage,
+  Prices,
+  type EvaluatePriceGroup,
+  type Price,
+  type PriceEvaluateResponse,
+  type PriceCreateParams,
+  type PriceUpdateParams,
+  type PriceListParams,
+  type PriceEvaluateParams,
+} from './prices/prices';
 export {
-  Subscription,
-  SubscriptionUsage,
-  Subscriptions,
-  SubscriptionFetchCostsResponse,
-  SubscriptionFetchScheduleResponse,
-  SubscriptionCreateParams,
-  SubscriptionUpdateParams,
-  SubscriptionListParams,
-  SubscriptionCancelParams,
-  SubscriptionFetchCostsParams,
-  SubscriptionFetchScheduleParams,
-  SubscriptionFetchUsageParams,
-  SubscriptionPriceIntervalsParams,
-  SubscriptionSchedulePlanChangeParams,
-  SubscriptionTriggerPhaseParams,
-  SubscriptionUnscheduleFixedFeeQuantityUpdatesParams,
-  SubscriptionUpdateFixedFeeQuantityParams,
-  SubscriptionUpdateTrialParams,
   SubscriptionsPage,
   SubscriptionFetchScheduleResponsesPage,
+  Subscriptions,
+  type Subscription,
+  type SubscriptionUsage,
+  type SubscriptionCreateResponse,
+  type SubscriptionCancelResponse,
+  type SubscriptionFetchCostsResponse,
+  type SubscriptionFetchScheduleResponse,
+  type SubscriptionPriceIntervalsResponse,
+  type SubscriptionSchedulePlanChangeResponse,
+  type SubscriptionTriggerPhaseResponse,
+  type SubscriptionUnscheduleCancellationResponse,
+  type SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse,
+  type SubscriptionUnschedulePendingPlanChangesResponse,
+  type SubscriptionUpdateFixedFeeQuantityResponse,
+  type SubscriptionUpdateTrialResponse,
+  type SubscriptionCreateParams,
+  type SubscriptionUpdateParams,
+  type SubscriptionListParams,
+  type SubscriptionCancelParams,
+  type SubscriptionFetchCostsParams,
+  type SubscriptionFetchScheduleParams,
+  type SubscriptionFetchUsageParams,
+  type SubscriptionPriceIntervalsParams,
+  type SubscriptionSchedulePlanChangeParams,
+  type SubscriptionTriggerPhaseParams,
+  type SubscriptionUnscheduleFixedFeeQuantityUpdatesParams,
+  type SubscriptionUpdateFixedFeeQuantityParams,
+  type SubscriptionUpdateTrialParams,
 } from './subscriptions';
-export { TopLevelPingResponse, TopLevel } from './top-level';
+export { TopLevel, type TopLevelPingResponse } from './top-level';
+
 export { Webhooks } from './webhooks';

package/src/resources/invoice-line-items.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
-import * as InvoiceLineItemsAPI from './invoice-line-items';
 import * as Shared from './shared';
 import * as PricesAPI from './prices/prices';
 
@@ -496,7 +495,9 @@ export interface InvoiceLineItemCreateParams {
   start_date: string;
 }
 
-export namespace InvoiceLineItems {
-  export import InvoiceLineItemCreateResponse = InvoiceLineItemsAPI.InvoiceLineItemCreateResponse;
-  export import InvoiceLineItemCreateParams = InvoiceLineItemsAPI.InvoiceLineItemCreateParams;
+export declare namespace InvoiceLineItems {
+  export {
+    type InvoiceLineItemCreateResponse as InvoiceLineItemCreateResponse,
+    type InvoiceLineItemCreateParams as InvoiceLineItemCreateParams,
+  };
 }

package/src/resources/invoices.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
 import * as Core from '../core';
-import * as InvoicesAPI from './invoices';
 import * as Shared from './shared';
 import * as PricesAPI from './prices/prices';
 import { Page, type PageParams } from '../pagination';
@@ -25,18 +24,9 @@ export class Invoices extends APIResource {
    */
   update(
     invoiceId: string,
-    body?: InvoiceUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Invoice>;
-  update(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
-  update(
-    invoiceId: string,
-    body: InvoiceUpdateParams | Core.RequestOptions = {},
+    body: InvoiceUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Invoice> {
-    if (isRequestOptions(body)) {
-      return this.update(invoiceId, {}, body);
-    }
     return this._client.put(`/invoices/${invoiceId}`, { body, ...options });
   }
 
@@ -81,17 +71,9 @@ export class Invoices extends APIResource {
    * subscription.
    */
   fetchUpcoming(
-    query?: InvoiceFetchUpcomingParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<InvoiceFetchUpcomingResponse>;
-  fetchUpcoming(options?: Core.RequestOptions): Core.APIPromise<InvoiceFetchUpcomingResponse>;
-  fetchUpcoming(
-    query: InvoiceFetchUpcomingParams | Core.RequestOptions = {},
+    query: InvoiceFetchUpcomingParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<InvoiceFetchUpcomingResponse> {
-    if (isRequestOptions(query)) {
-      return this.fetchUpcoming({}, query);
-    }
     return this._client.get('/invoices/upcoming', { query, ...options });
   }
 
@@ -132,6 +114,14 @@ export class Invoices extends APIResource {
     return this._client.post(`/invoices/${invoiceId}/mark_paid`, { body, ...options });
   }
 
+  /**
+   * This endpoint collects payment for an invoice using the customer's default
+   * payment method. This action can only be taken on invoices with status "issued".
+   */
+  pay(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
+    return this._client.post(`/invoices/${invoiceId}/pay`, options);
+  }
+
   /**
    * This endpoint allows an invoice's status to be set the `void` status. This can
    * only be done to invoices that are in the `issued` status.
@@ -301,7 +291,7 @@ export interface Invoice {
    * list is provided, the first discount in the list will be returned. If the list
    * is empty, `None` will be returned.
    */
-  discount: unknown | null;
+  discount: unknown;
 
   discounts: Array<Shared.InvoiceLevelDiscount>;
 
@@ -386,6 +376,11 @@ export interface Invoice {
    */
   paid_at: string | null;
 
+  /**
+   * A list of payment attempts associated with the invoice
+   */
+  payment_attempts: Array<Invoice.PaymentAttempt>;
+
   /**
    * If payment was attempted on this invoice but failed, this will be the time of
    * the most recent attempt.
@@ -1310,6 +1305,38 @@ export namespace Invoice {
     minimum_amount: string;
   }
 
+  export interface PaymentAttempt {
+    /**
+     * The ID of the payment attempt.
+     */
+    id: string;
+
+    /**
+     * The amount of the payment attempt.
+     */
+    amount: string;
+
+    /**
+     * The time at which the payment attempt was created.
+     */
+    created_at: string;
+
+    /**
+     * The payment provider that attempted to collect the payment.
+     */
+    payment_provider: 'stripe' | null;
+
+    /**
+     * The ID of the payment attempt in the payment provider.
+     */
+    payment_provider_id: string | null;
+
+    /**
+     * Whether the payment attempt succeeded.
+     */
+    succeeded: boolean;
+  }
+
   export interface ShippingAddress {
     city: string | null;
 
@@ -1475,7 +1502,7 @@ export interface InvoiceFetchUpcomingResponse {
    * list is provided, the first discount in the list will be returned. If the list
    * is empty, `None` will be returned.
    */
-  discount: unknown | null;
+  discount: unknown;
 
   discounts: Array<Shared.InvoiceLevelDiscount>;
 
@@ -1555,6 +1582,11 @@ export interface InvoiceFetchUpcomingResponse {
    */
   paid_at: string | null;
 
+  /**
+   * A list of payment attempts associated with the invoice
+   */
+  payment_attempts: Array<InvoiceFetchUpcomingResponse.PaymentAttempt>;
+
   /**
    * If payment was attempted on this invoice but failed, this will be the time of
    * the most recent attempt.
@@ -2484,6 +2516,38 @@ export namespace InvoiceFetchUpcomingResponse {
     minimum_amount: string;
   }
 
+  export interface PaymentAttempt {
+    /**
+     * The ID of the payment attempt.
+     */
+    id: string;
+
+    /**
+     * The amount of the payment attempt.
+     */
+    amount: string;
+
+    /**
+     * The time at which the payment attempt was created.
+     */
+    created_at: string;
+
+    /**
+     * The payment provider that attempted to collect the payment.
+     */
+    payment_provider: 'stripe' | null;
+
+    /**
+     * The ID of the payment attempt in the payment provider.
+     */
+    payment_provider_id: string | null;
+
+    /**
+     * Whether the payment attempt succeeded.
+     */
+    succeeded: boolean;
+  }
+
   export interface ShippingAddress {
     city: string | null;
 
@@ -2623,6 +2687,12 @@ export interface InvoiceListParams extends PageParams {
 
   due_date?: string | null;
 
+  /**
+   * Filters invoices by their due dates within a specific time range in the past.
+   * Specify the range as a number followed by 'd' (days) or 'm' (months). For
+   * example, '7d' filters invoices due in the last 7 days, and '2m' filters those
+   * due in the last 2 months.
+   */
   due_date_window?: string | null;
 
   'due_date[gt]'?: string | null;
@@ -2647,13 +2717,16 @@ export interface InvoiceListParams extends PageParams {
 }
 
 export interface InvoiceFetchUpcomingParams {
-  subscription_id?: string;
+  subscription_id: string;
 }
 
 export interface InvoiceIssueParams {
   /**
    * If true, the invoice will be issued synchronously. If false, the invoice will be
-   * issued asynchronously.
+   * issued asynchronously. The synchronous option is only available for invoices
+   * containin no usage fees. If the invoice is configured to sync to an external
+   * provider, a successful response from this endpoint guarantees the invoice is
+   * present in the provider.
    */
   synchronous?: boolean;
 }
@@ -2675,14 +2748,18 @@ export interface InvoiceMarkPaidParams {
   notes?: string | null;
 }
 
-export namespace Invoices {
-  export import Invoice = InvoicesAPI.Invoice;
-  export import InvoiceFetchUpcomingResponse = InvoicesAPI.InvoiceFetchUpcomingResponse;
-  export import InvoicesPage = InvoicesAPI.InvoicesPage;
-  export import InvoiceCreateParams = InvoicesAPI.InvoiceCreateParams;
-  export import InvoiceUpdateParams = InvoicesAPI.InvoiceUpdateParams;
-  export import InvoiceListParams = InvoicesAPI.InvoiceListParams;
-  export import InvoiceFetchUpcomingParams = InvoicesAPI.InvoiceFetchUpcomingParams;
-  export import InvoiceIssueParams = InvoicesAPI.InvoiceIssueParams;
-  export import InvoiceMarkPaidParams = InvoicesAPI.InvoiceMarkPaidParams;
+Invoices.InvoicesPage = InvoicesPage;
+
+export declare namespace Invoices {
+  export {
+    type Invoice as Invoice,
+    type InvoiceFetchUpcomingResponse as InvoiceFetchUpcomingResponse,
+    InvoicesPage as InvoicesPage,
+    type InvoiceCreateParams as InvoiceCreateParams,
+    type InvoiceUpdateParams as InvoiceUpdateParams,
+    type InvoiceListParams as InvoiceListParams,
+    type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams,
+    type InvoiceIssueParams as InvoiceIssueParams,
+    type InvoiceMarkPaidParams as InvoiceMarkPaidParams,
+  };
 }

package/src/resources/items.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
 import * as Core from '../core';
-import * as ItemsAPI from './items';
 import { Page, type PageParams } from '../pagination';
 
 export class Items extends APIResource {
@@ -17,16 +16,7 @@ export class Items extends APIResource {
   /**
    * This endpoint can be used to update properties on the Item.
    */
-  update(itemId: string, body?: ItemUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
-  update(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item>;
-  update(
-    itemId: string,
-    body: ItemUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Item> {
-    if (isRequestOptions(body)) {
-      return this.update(itemId, {}, body);
-    }
+  update(itemId: string, body: ItemUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Item> {
     return this._client.put(`/items/${itemId}`, { body, ...options });
   }
 
@@ -116,10 +106,14 @@ export namespace ItemUpdateParams {
 
 export interface ItemListParams extends PageParams {}
 
-export namespace Items {
-  export import Item = ItemsAPI.Item;
-  export import ItemsPage = ItemsAPI.ItemsPage;
-  export import ItemCreateParams = ItemsAPI.ItemCreateParams;
-  export import ItemUpdateParams = ItemsAPI.ItemUpdateParams;
-  export import ItemListParams = ItemsAPI.ItemListParams;
+Items.ItemsPage = ItemsPage;
+
+export declare namespace Items {
+  export {
+    type Item as Item,
+    ItemsPage as ItemsPage,
+    type ItemCreateParams as ItemCreateParams,
+    type ItemUpdateParams as ItemUpdateParams,
+    type ItemListParams as ItemListParams,
+  };
 }

package/src/resources/metrics.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
 import * as Core from '../core';
-import * as MetricsAPI from './metrics';
 import * as ItemsAPI from './items';
 import { Page, type PageParams } from '../pagination';
 
@@ -25,18 +24,9 @@ export class Metrics extends APIResource {
    */
   update(
     metricId: string,
-    body?: MetricUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<BillableMetric>;
-  update(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
-  update(
-    metricId: string,
-    body: MetricUpdateParams | Core.RequestOptions = {},
+    body: MetricUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<BillableMetric> {
-    if (isRequestOptions(body)) {
-      return this.update(metricId, {}, body);
-    }
     return this._client.put(`/metrics/${metricId}`, { body, ...options });
   }
 
@@ -149,10 +139,14 @@ export interface MetricListParams extends PageParams {
   'created_at[lte]'?: string | null;
 }
 
-export namespace Metrics {
-  export import BillableMetric = MetricsAPI.BillableMetric;
-  export import BillableMetricsPage = MetricsAPI.BillableMetricsPage;
-  export import MetricCreateParams = MetricsAPI.MetricCreateParams;
-  export import MetricUpdateParams = MetricsAPI.MetricUpdateParams;
-  export import MetricListParams = MetricsAPI.MetricListParams;
+Metrics.BillableMetricsPage = BillableMetricsPage;
+
+export declare namespace Metrics {
+  export {
+    type BillableMetric as BillableMetric,
+    BillableMetricsPage as BillableMetricsPage,
+    type MetricCreateParams as MetricCreateParams,
+    type MetricUpdateParams as MetricUpdateParams,
+    type MetricListParams as MetricListParams,
+  };
 }

package/src/resources/plans/external-plan-id.ts

@@ -1,9 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import * as ExternalPlanIDAPI from './external-plan-id';
 import * as PlansAPI from './plans';
 
 export class ExternalPlanID extends APIResource {
@@ -15,18 +13,9 @@ export class ExternalPlanID extends APIResource {
    */
   update(
     otherExternalPlanId: string,
-    body?: ExternalPlanIDUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PlansAPI.Plan>;
-  update(otherExternalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan>;
-  update(
-    otherExternalPlanId: string,
-    body: ExternalPlanIDUpdateParams | Core.RequestOptions = {},
+    body: ExternalPlanIDUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PlansAPI.Plan> {
-    if (isRequestOptions(body)) {
-      return this.update(otherExternalPlanId, {}, body);
-    }
     return this._client.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
   }
 
@@ -69,6 +58,6 @@ export interface ExternalPlanIDUpdateParams {
   metadata?: Record<string, string | null> | null;
 }
 
-export namespace ExternalPlanID {
-  export import ExternalPlanIDUpdateParams = ExternalPlanIDAPI.ExternalPlanIDUpdateParams;
+export declare namespace ExternalPlanID {
+  export { type ExternalPlanIDUpdateParams as ExternalPlanIDUpdateParams };
 }

package/src/resources/plans/index.ts

@@ -1,4 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { ExternalPlanIDUpdateParams, ExternalPlanID } from './external-plan-id';
-export { Plan, PlanCreateParams, PlanUpdateParams, PlanListParams, PlansPage, Plans } from './plans';
+export { ExternalPlanID, type ExternalPlanIDUpdateParams } from './external-plan-id';
+export {
+  PlansPage,
+  Plans,
+  type Plan,
+  type PlanCreateParams,
+  type PlanUpdateParams,
+  type PlanListParams,
+} from './plans';