orb-billing 4.17.0 → 4.18.0

package/src/resources/invoices.ts

@@ -50,6 +50,10 @@ export class Invoices extends APIResource {
    * the next page of results if they exist.
    *
    * By default, this only returns invoices that are `issued`, `paid`, or `synced`.
+   *
+   * When fetching any `draft` invoices, this returns the last-computed invoice
+   * values for each draft invoice, which may not always be up-to-date since Orb
+   * regularly refreshes invoices asynchronously.
    */
   list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
   list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
@@ -284,9 +288,9 @@ export interface Invoice {
    * provided, the first discount in the list will be returned. If the list is empty,
    * `None` will be returned.
    */
-  discount: Shared.Discount | null;
+  discount: Invoice.PercentageDiscount | Invoice.AmountDiscount | Invoice.TrialDiscount | null;
 
-  discounts: Array<Shared.Discount>;
+  discounts: Array<Invoice.PercentageDiscount | Invoice.AmountDiscount | Invoice.TrialDiscount>;
 
   /**
    * When the invoice payment is due.
@@ -301,7 +305,8 @@ export interface Invoice {
   eligible_to_issue_at: string | null;
 
   /**
-   * A URL for the invoice portal.
+   * A URL for the customer-facing invoice portal. This URL expires 30 days after the
+   * invoice's due date, or 60 days after being re-generated through the UI.
    */
   hosted_invoice_url: string | null;
 
@@ -826,6 +831,120 @@ export namespace Invoice {
     value: string;
   }
 
+  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>;
+
+    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`.
+     */
+    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;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * 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: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
+  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>;
+
+    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`.
+     */
+    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;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * 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: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
   export interface LineItem {
     /**
      * A unique ID for this line item.
@@ -1457,9 +1576,17 @@ export interface InvoiceFetchUpcomingResponse {
    * provided, the first discount in the list will be returned. If the list is empty,
    * `None` will be returned.
    */
-  discount: Shared.Discount | null;
+  discount:
+    | InvoiceFetchUpcomingResponse.PercentageDiscount
+    | InvoiceFetchUpcomingResponse.AmountDiscount
+    | InvoiceFetchUpcomingResponse.TrialDiscount
+    | null;
 
-  discounts: Array<Shared.Discount>;
+  discounts: Array<
+    | InvoiceFetchUpcomingResponse.PercentageDiscount
+    | InvoiceFetchUpcomingResponse.AmountDiscount
+    | InvoiceFetchUpcomingResponse.TrialDiscount
+  >;
 
   /**
    * When the invoice payment is due.
@@ -1474,7 +1601,8 @@ export interface InvoiceFetchUpcomingResponse {
   eligible_to_issue_at: string | null;
 
   /**
-   * A URL for the invoice portal.
+   * A URL for the customer-facing invoice portal. This URL expires 30 days after the
+   * invoice's due date, or 60 days after being re-generated through the UI.
    */
   hosted_invoice_url: string | null;
 
@@ -1999,6 +2127,120 @@ export namespace InvoiceFetchUpcomingResponse {
     value: string;
   }
 
+  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>;
+
+    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`.
+     */
+    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;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * 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: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
+  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>;
+
+    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`.
+     */
+    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;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * 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: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
   export interface LineItem {
     /**
      * A unique ID for this line item.

package/src/resources/plans/plans.ts

@@ -103,8 +103,8 @@ export interface Plan {
   created_at: string;
 
   /**
-   * An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
-   * prices.
+   * @deprecated: An ISO 4217 currency string or custom pricing unit (`credits`) for
+   * this plan's prices.
    */
   currency: string;
 

package/src/resources/subscriptions.ts

@@ -93,11 +93,11 @@ export class Subscriptions extends APIResource {
    *     "tiers": [
    *       {
    *         "first_unit":"1",
-   *         "last_unit": "10",
+   *         "last_unit": "11",
    *         "unit_amount": "0.50"
    *       },
    *       {
-   *         "first_unit": "10",
+   *         "first_unit": "11",
    *         "last_unit": null,
    *         "unit_amount": "0.10"
    *       }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.17.0'; // x-release-please-version
+export const VERSION = '4.18.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.17.0";
+export declare const VERSION = "4.18.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.17.0'; // x-release-please-version
+exports.VERSION = '4.18.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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