orb-billing 4.51.0 → 4.53.0

package/src/resources/customers/customers.ts

@@ -138,6 +138,42 @@ export class Customers extends APIResource {
     return this._client.get(`/customers/external_customer_id/${externalCustomerId}`, options);
   }
 
+  /**
+   * Sync Orb's payment methods for the customer with their gateway.
+   *
+   * This method can be called before taking an action that may cause the customer to
+   * be charged, ensuring that the most up-to-date payment method is charged.
+   *
+   * **Note**: This functionality is currently only available for Stripe.
+   */
+  syncPaymentMethodsFromGateway(
+    externalCustomerId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    return this._client.post(
+      `/customers/external_customer_id/${externalCustomerId}/sync_payment_methods_from_gateway`,
+      { ...options, headers: { Accept: '*/*', ...options?.headers } },
+    );
+  }
+
+  /**
+   * Sync Orb's payment methods for the customer with their gateway.
+   *
+   * This method can be called before taking an action that may cause the customer to
+   * be charged, ensuring that the most up-to-date payment method is charged.
+   *
+   * **Note**: This functionality is currently only available for Stripe.
+   */
+  syncPaymentMethodsFromGatewayByExternalCustomerId(
+    customerId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    return this._client.post(`/customers/${customerId}/sync_payment_methods_from_gateway`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
   /**
    * This endpoint is used to update customer details given an `external_customer_id`
    * (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the

package/src/resources/invoices.ts

@@ -296,9 +296,10 @@ export interface Invoice {
   discounts: Array<Shared.InvoiceLevelDiscount>;
 
   /**
-   * When the invoice payment is due.
+   * When the invoice payment is due. The due date is null if the invoice is not yet
+   * finalized.
    */
-  due_date: string;
+  due_date: string | null;
 
   /**
    * If the invoice has a status of `draft`, this will be the time that the invoice
@@ -1286,9 +1287,10 @@ export interface InvoiceFetchUpcomingResponse {
   discounts: Array<Shared.InvoiceLevelDiscount>;
 
   /**
-   * When the invoice payment is due.
+   * When the invoice payment is due. The due date is null if the invoice is not yet
+   * finalized.
    */
-  due_date: string;
+  due_date: string | null;
 
   /**
    * If the invoice has a status of `draft`, this will be the time that the invoice
@@ -2282,7 +2284,7 @@ export interface InvoiceIssueParams {
   /**
    * If true, the invoice will be issued synchronously. If false, the invoice will be
    * issued asynchronously. The synchronous option is only available for invoices
-   * containin no usage fees. If the invoice is configured to sync to an external
+   * that have 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.
    */

package/src/resources/plans/plans.ts

@@ -497,7 +497,7 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanMatrixWithDisplayNamePrice
     | PlanCreateParams.NewPlanBulkWithProrationPrice
     | PlanCreateParams.NewPlanGroupedTieredPackagePrice
-    | PlanCreateParams.NewPlanMaxGroupTieredPrice
+    | PlanCreateParams.NewPlanMaxGroupTieredPackagePrice
   >;
 
   /**
@@ -3073,7 +3073,7 @@ export namespace PlanCreateParams {
     }
   }
 
-  export interface NewPlanMaxGroupTieredPrice {
+  export interface NewPlanMaxGroupTieredPackagePrice {
     /**
      * The cadence to bill for this price on.
      */
@@ -3084,9 +3084,9 @@ export namespace PlanCreateParams {
      */
     item_id: string;
 
-    max_group_tiered_config: Record<string, unknown>;
+    max_group_tiered_package_config: Record<string, unknown>;
 
-    model_type: 'max_group_tiered';
+    model_type: 'max_group_tiered_package';
 
     /**
      * The name of the price.
@@ -3109,7 +3109,7 @@ export namespace PlanCreateParams {
      * For custom cadence: specifies the duration of the billing period in days or
      * months.
      */
-    billing_cycle_configuration?: NewPlanMaxGroupTieredPrice.BillingCycleConfiguration | null;
+    billing_cycle_configuration?: NewPlanMaxGroupTieredPackagePrice.BillingCycleConfiguration | null;
 
     /**
      * The per unit conversion rate of the price currency to the invoicing currency.
@@ -3142,7 +3142,7 @@ export namespace PlanCreateParams {
      * Within each billing cycle, specifies the cadence at which invoices are produced.
      * If unspecified, a single invoice is produced per billing cycle.
      */
-    invoicing_cycle_configuration?: NewPlanMaxGroupTieredPrice.InvoicingCycleConfiguration | null;
+    invoicing_cycle_configuration?: NewPlanMaxGroupTieredPackagePrice.InvoicingCycleConfiguration | null;
 
     /**
      * User-specified key/value pairs for the resource. Individual keys can be removed
@@ -3152,7 +3152,7 @@ export namespace PlanCreateParams {
     metadata?: Record<string, string | null> | null;
   }
 
-  export namespace NewPlanMaxGroupTieredPrice {
+  export namespace NewPlanMaxGroupTieredPackagePrice {
     /**
      * For custom cadence: specifies the duration of the billing period in days or
      * months.

package/src/resources/prices/prices.ts

@@ -147,7 +147,7 @@ export type Price =
   | Price.MatrixWithDisplayNamePrice
   | Price.BulkWithProrationPrice
   | Price.GroupedTieredPackagePrice
-  | Price.MaxGroupTieredPrice;
+  | Price.MaxGroupTieredPackagePrice;
 
 export namespace Price {
   export interface UnitPrice {
@@ -2999,12 +2999,12 @@ export namespace Price {
     }
   }
 
-  export interface MaxGroupTieredPrice {
+  export interface MaxGroupTieredPackagePrice {
     id: string;
 
-    billable_metric: MaxGroupTieredPrice.BillableMetric | null;
+    billable_metric: MaxGroupTieredPackagePrice.BillableMetric | null;
 
-    billing_cycle_configuration: MaxGroupTieredPrice.BillingCycleConfiguration;
+    billing_cycle_configuration: MaxGroupTieredPackagePrice.BillingCycleConfiguration;
 
     cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
 
@@ -3012,7 +3012,7 @@ export namespace Price {
 
     created_at: string;
 
-    credit_allocation: MaxGroupTieredPrice.CreditAllocation | null;
+    credit_allocation: MaxGroupTieredPackagePrice.CreditAllocation | null;
 
     currency: string;
 
@@ -3022,13 +3022,13 @@ export namespace Price {
 
     fixed_price_quantity: number | null;
 
-    invoicing_cycle_configuration: MaxGroupTieredPrice.InvoicingCycleConfiguration | null;
+    invoicing_cycle_configuration: MaxGroupTieredPackagePrice.InvoicingCycleConfiguration | null;
 
-    item: MaxGroupTieredPrice.Item;
+    item: MaxGroupTieredPackagePrice.Item;
 
-    max_group_tiered_config: Record<string, unknown>;
+    max_group_tiered_package_config: Record<string, unknown>;
 
-    maximum: MaxGroupTieredPrice.Maximum | null;
+    maximum: MaxGroupTieredPackagePrice.Maximum | null;
 
     maximum_amount: string | null;
 
@@ -3040,11 +3040,11 @@ export namespace Price {
      */
     metadata: Record<string, string>;
 
-    minimum: MaxGroupTieredPrice.Minimum | null;
+    minimum: MaxGroupTieredPackagePrice.Minimum | null;
 
     minimum_amount: string | null;
 
-    model_type: 'max_group_tiered';
+    model_type: 'max_group_tiered_package';
 
     name: string;
 
@@ -3053,7 +3053,7 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
   }
 
-  export namespace MaxGroupTieredPrice {
+  export namespace MaxGroupTieredPackagePrice {
     export interface BillableMetric {
       id: string;
     }
@@ -3127,7 +3127,7 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingThresholdTotalAmountPrice
   | PriceCreateParams.NewFloatingTieredPackagePrice
   | PriceCreateParams.NewFloatingGroupedTieredPrice
-  | PriceCreateParams.NewFloatingMaxGroupTieredPrice
+  | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice
   | PriceCreateParams.NewFloatingTieredWithMinimumPrice
   | PriceCreateParams.NewFloatingPackageWithAllocationPrice
   | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice
@@ -4695,7 +4695,7 @@ export declare namespace PriceCreateParams {
     }
   }
 
-  export interface NewFloatingMaxGroupTieredPrice {
+  export interface NewFloatingMaxGroupTieredPackagePrice {
     /**
      * The cadence to bill for this price on.
      */
@@ -4711,9 +4711,9 @@ export declare namespace PriceCreateParams {
      */
     item_id: string;
 
-    max_group_tiered_config: Record<string, unknown>;
+    max_group_tiered_package_config: Record<string, unknown>;
 
-    model_type: 'max_group_tiered';
+    model_type: 'max_group_tiered_package';
 
     /**
      * The name of the price.
@@ -4736,7 +4736,7 @@ export declare namespace PriceCreateParams {
      * For custom cadence: specifies the duration of the billing period in days or
      * months.
      */
-    billing_cycle_configuration?: PriceCreateParams.NewFloatingMaxGroupTieredPrice.BillingCycleConfiguration | null;
+    billing_cycle_configuration?: PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice.BillingCycleConfiguration | null;
 
     /**
      * The per unit conversion rate of the price currency to the invoicing currency.
@@ -4763,7 +4763,7 @@ export declare namespace PriceCreateParams {
      * Within each billing cycle, specifies the cadence at which invoices are produced.
      * If unspecified, a single invoice is produced per billing cycle.
      */
-    invoicing_cycle_configuration?: PriceCreateParams.NewFloatingMaxGroupTieredPrice.InvoicingCycleConfiguration | null;
+    invoicing_cycle_configuration?: PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice.InvoicingCycleConfiguration | null;
 
     /**
      * User-specified key/value pairs for the resource. Individual keys can be removed
@@ -4773,7 +4773,7 @@ export declare namespace PriceCreateParams {
     metadata?: Record<string, string | null> | null;
   }
 
-  export namespace NewFloatingMaxGroupTieredPrice {
+  export namespace NewFloatingMaxGroupTieredPackagePrice {
     /**
      * For custom cadence: specifies the duration of the billing period in days or
      * months.

package/src/resources/subscriptions.ts

@@ -13351,7 +13351,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Add.NewFloatingThresholdTotalAmountPrice
       | Add.NewFloatingTieredPackagePrice
       | Add.NewFloatingGroupedTieredPrice
-      | Add.NewFloatingMaxGroupTieredPrice
+      | Add.NewFloatingMaxGroupTieredPackagePrice
       | Add.NewFloatingTieredWithMinimumPrice
       | Add.NewFloatingPackageWithAllocationPrice
       | Add.NewFloatingTieredPackageWithMinimumPrice
@@ -14994,7 +14994,7 @@ export namespace SubscriptionPriceIntervalsParams {
       }
     }
 
-    export interface NewFloatingMaxGroupTieredPrice {
+    export interface NewFloatingMaxGroupTieredPackagePrice {
       /**
        * The cadence to bill for this price on.
        */
@@ -15010,9 +15010,9 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       item_id: string;
 
-      max_group_tiered_config: Record<string, unknown>;
+      max_group_tiered_package_config: Record<string, unknown>;
 
-      model_type: 'max_group_tiered';
+      model_type: 'max_group_tiered_package';
 
       /**
        * The name of the price.
@@ -15035,7 +15035,7 @@ export namespace SubscriptionPriceIntervalsParams {
        * For custom cadence: specifies the duration of the billing period in days or
        * months.
        */
-      billing_cycle_configuration?: NewFloatingMaxGroupTieredPrice.BillingCycleConfiguration | null;
+      billing_cycle_configuration?: NewFloatingMaxGroupTieredPackagePrice.BillingCycleConfiguration | null;
 
       /**
        * The per unit conversion rate of the price currency to the invoicing currency.
@@ -15062,7 +15062,7 @@ export namespace SubscriptionPriceIntervalsParams {
        * Within each billing cycle, specifies the cadence at which invoices are produced.
        * If unspecified, a single invoice is produced per billing cycle.
        */
-      invoicing_cycle_configuration?: NewFloatingMaxGroupTieredPrice.InvoicingCycleConfiguration | null;
+      invoicing_cycle_configuration?: NewFloatingMaxGroupTieredPackagePrice.InvoicingCycleConfiguration | null;
 
       /**
        * User-specified key/value pairs for the resource. Individual keys can be removed
@@ -15072,7 +15072,7 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
-    export namespace NewFloatingMaxGroupTieredPrice {
+    export namespace NewFloatingMaxGroupTieredPackagePrice {
       /**
        * For custom cadence: specifies the duration of the billing period in days or
        * months.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.51.0'; // x-release-please-version
+export const VERSION = '4.53.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.51.0";
+export declare const VERSION = "4.53.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.51.0'; // x-release-please-version
+exports.VERSION = '4.53.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.51.0'; // x-release-please-version
+export const VERSION = '4.53.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map