orb-billing 5.43.0 → 5.45.0

package/src/resources/coupons/coupons.ts

@@ -8,6 +8,9 @@ import * as SubscriptionsAPI from './subscriptions';
 import { SubscriptionListParams, Subscriptions } from './subscriptions';
 import { Page, type PageParams } from '../../pagination';
 
+/**
+ * A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users.
+ */
 export class Coupons extends APIResource {
   subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
 

package/src/resources/coupons/subscriptions.ts

@@ -7,6 +7,9 @@ import * as SubscriptionsAPI from '../subscriptions';
 import { SubscriptionsPage } from '../subscriptions';
 import { type PageParams } from '../../pagination';
 
+/**
+ * A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users.
+ */
 export class Subscriptions extends APIResource {
   /**
    * This endpoint returns a list of all subscriptions that have redeemed a given

package/src/resources/credit-blocks.ts

@@ -2,7 +2,11 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
+import * as Shared from './shared';
 
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+ */
 export class CreditBlocks extends APIResource {
   /**
    * This endpoint returns a credit block identified by its block_id.
@@ -34,6 +38,29 @@ export class CreditBlocks extends APIResource {
       headers: { Accept: '*/*', ...options?.headers },
     });
   }
+
+  /**
+   * This endpoint returns the credit block and its associated purchasing invoices.
+   *
+   * If a credit block was purchased (as opposed to being manually added or allocated
+   * from a subscription), this endpoint returns the invoices that were created to
+   * charge the customer for the credit block. For credit blocks with payment
+   * schedules spanning multiple periods (e.g., monthly payments over 12 months),
+   * multiple invoices will be returned.
+   *
+   * If the credit block was not purchased (e.g., manual increment, allocation), an
+   * empty invoices list is returned.
+   *
+   * **Note: This endpoint is currently experimental and its interface may change in
+   * future releases. Please contact support before building production integrations
+   * against this endpoint.**
+   */
+  listInvoices(
+    blockId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CreditBlockListInvoicesResponse> {
+    return this._client.get(`/credit_blocks/${blockId}/invoices`, options);
+  }
 }
 
 /**
@@ -52,6 +79,14 @@ export interface CreditBlockRetrieveResponse {
 
   maximum_initial_balance: number | null;
 
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: { [key: string]: string };
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -76,6 +111,80 @@ export namespace CreditBlockRetrieveResponse {
   }
 }
 
+export interface CreditBlockListInvoicesResponse {
+  /**
+   * The Credit Block resource models prepaid credits within Orb.
+   */
+  block: CreditBlockListInvoicesResponse.Block;
+
+  invoices: Array<CreditBlockListInvoicesResponse.Invoice>;
+}
+
+export namespace CreditBlockListInvoicesResponse {
+  /**
+   * The Credit Block resource models prepaid credits within Orb.
+   */
+  export interface Block {
+    id: string;
+
+    balance: number;
+
+    effective_date: string | null;
+
+    expiry_date: string | null;
+
+    filters: Array<Block.Filter>;
+
+    maximum_initial_balance: number | null;
+
+    /**
+     * User specified key-value pairs for the resource. If not present, this defaults
+     * to an empty dictionary. Individual keys can be removed by setting the value to
+     * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+     * `null`.
+     */
+    metadata: { [key: string]: string };
+
+    per_unit_cost_basis: string | null;
+
+    status: 'active' | 'pending_payment';
+  }
+
+  export namespace Block {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
+  export interface Invoice {
+    id: string;
+
+    customer: Shared.CustomerMinified;
+
+    invoice_number: string;
+
+    status: 'issued' | 'paid' | 'synced' | 'void' | 'draft';
+
+    subscription: Shared.SubscriptionMinified | null;
+  }
+}
+
 export declare namespace CreditBlocks {
-  export { type CreditBlockRetrieveResponse as CreditBlockRetrieveResponse };
+  export {
+    type CreditBlockRetrieveResponse as CreditBlockRetrieveResponse,
+    type CreditBlockListInvoicesResponse as CreditBlockListInvoicesResponse,
+  };
 }

package/src/resources/credit-notes.ts

@@ -7,6 +7,10 @@ import * as Shared from './shared';
 import { CreditNotesPage } from './shared';
 import { type PageParams } from '../pagination';
 
+/**
+ * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
+ * particular invoice.
+ */
 export class CreditNotes extends APIResource {
   /**
    * This endpoint is used to create a single

package/src/resources/customers/balance-transactions.ts

@@ -6,6 +6,22 @@ import * as Core from '../../core';
 import * as Shared from '../shared';
 import { Page, type PageParams } from '../../pagination';
 
+/**
+ * A customer is a buyer of your products, and the other party to the billing relationship.
+ *
+ * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
+ * match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
+ * `external_customer_id` with your own identifier. See
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
+ * aliases work in Orb.
+ *
+ * In addition to having an identifier in your system, a customer may exist in a payment provider solution like
+ * Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
+ *
+ * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
+ * defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
+ * information on what this timezone parameter influences within Orb.
+ */
 export class BalanceTransactions extends APIResource {
   /**
    * Creates an immutable balance transaction that updates the customer's balance and

package/src/resources/customers/costs.ts

@@ -5,6 +5,22 @@ import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
 import * as Shared from '../shared';
 
+/**
+ * A customer is a buyer of your products, and the other party to the billing relationship.
+ *
+ * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
+ * match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
+ * `external_customer_id` with your own identifier. See
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
+ * aliases work in Orb.
+ *
+ * In addition to having an identifier in your system, a customer may exist in a payment provider solution like
+ * Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
+ *
+ * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
+ * defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
+ * information on what this timezone parameter influences within Orb.
+ */
 export class Costs extends APIResource {
   /**
    * This endpoint is used to fetch a day-by-day snapshot of a customer's costs in

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

@@ -42,6 +42,9 @@ import {
 } from './top-ups';
 import { Page, type PageParams } from '../../../pagination';
 
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+ */
 export class Credits extends APIResource {
   ledger: LedgerAPI.Ledger = new LedgerAPI.Ledger(this._client);
   topUps: TopUpsAPI.TopUps = new TopUpsAPI.TopUps(this._client);
@@ -54,6 +57,11 @@ export class Credits extends APIResource {
    *
    * Note that `currency` defaults to credits if not specified. To use a real world
    * currency, set `currency` to an ISO 4217 string.
+   *
+   * Results can be filtered by the block's `effective_date` using the
+   * `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
+   * `effective_date[lte]` query parameters. This filters on when the credit block
+   * becomes effective, which may differ from creation time for backdated credits.
    */
   list(
     customerId: string,
@@ -86,6 +94,11 @@ export class Credits extends APIResource {
    *
    * Note that `currency` defaults to credits if not specified. To use a real world
    * currency, set `currency` to an ISO 4217 string.
+   *
+   * Results can be filtered by the block's `effective_date` using the
+   * `effective_date[gte]`, `effective_date[gt]`, `effective_date[lt]`, and
+   * `effective_date[lte]` query parameters. This filters on when the credit block
+   * becomes effective, which may differ from creation time for backdated credits.
    */
   listByExternalId(
     externalCustomerId: string,
@@ -129,6 +142,14 @@ export interface CreditListResponse {
 
   maximum_initial_balance: number | null;
 
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: { [key: string]: string };
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -169,6 +190,14 @@ export interface CreditListByExternalIDResponse {
 
   maximum_initial_balance: number | null;
 
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: { [key: string]: string };
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -202,6 +231,14 @@ export interface CreditListParams extends PageParams {
    */
   currency?: string | null;
 
+  'effective_date[gt]'?: string | null;
+
+  'effective_date[gte]'?: string | null;
+
+  'effective_date[lt]'?: string | null;
+
+  'effective_date[lte]'?: string | null;
+
   /**
    * If set to True, all expired and depleted blocks, as well as active block will be
    * returned.
@@ -215,6 +252,14 @@ export interface CreditListByExternalIDParams extends PageParams {
    */
   currency?: string | null;
 
+  'effective_date[gt]'?: string | null;
+
+  'effective_date[gte]'?: string | null;
+
+  'effective_date[lt]'?: string | null;
+
+  'effective_date[lte]'?: string | null;
+
   /**
    * If set to True, all expired and depleted blocks, as well as active block will be
    * returned.

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

@@ -6,6 +6,9 @@ import * as Core from '../../../core';
 import * as Shared from '../../shared';
 import { Page, type PageParams } from '../../../pagination';
 
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+ */
 export class Ledger extends APIResource {
   /**
    * The credits ledger provides _auditing_ functionality over Orb's credits system
@@ -162,7 +165,14 @@ export class Ledger extends APIResource {
    * also generate a one-off invoice for the customer for the credits pre-purchase.
    * Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
    * on the invoice are calculated by multiplying the cost basis with the number of
-   * credit units added.
+   * credit units added. If you invoice or handle payment of credits outside of Orb
+   * (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
+   * `true` to prevent duplicate invoicing effects.
+   *
+   * - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
+   *   and `invoice_settings` must be included
+   * - if `invoice_settings` is passed, one of either `custom_due_date` or
+   *   `net_terms` is required to determine the due date
    *
    * ## Deducting Credits
    *
@@ -282,7 +292,14 @@ export class Ledger extends APIResource {
    * also generate a one-off invoice for the customer for the credits pre-purchase.
    * Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
    * on the invoice are calculated by multiplying the cost basis with the number of
-   * credit units added.
+   * credit units added. If you invoice or handle payment of credits outside of Orb
+   * (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
+   * `true` to prevent duplicate invoicing effects.
+   *
+   * - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
+   *   and `invoice_settings` must be included
+   * - if `invoice_settings` is passed, one of either `custom_due_date` or
+   *   `net_terms` is required to determine the due date
    *
    * ## Deducting Credits
    *
@@ -957,6 +974,11 @@ export declare namespace LedgerCreateEntryParams {
        */
       item_id?: string | null;
 
+      /**
+       * If true, the new credits purchase invoice will be marked as paid.
+       */
+      mark_as_paid?: boolean;
+
       /**
        * An optional memo to display on the invoice.
        */
@@ -967,7 +989,8 @@ export declare namespace LedgerCreateEntryParams {
        * based on the invoice or issuance date, depending on the account's configured due
        * date calculation method. A value of '0' here represents that the invoice is due
        * on issue, whereas a value of '30' represents that the customer has 30 days to
-       * pay the invoice. Do not set this field if you want to set a custom due date.
+       * pay the invoice. You must set either `net_terms` or `custom_due_date`, but not
+       * both.
        */
       net_terms?: number | null;
 
@@ -1255,6 +1278,11 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
        */
       item_id?: string | null;
 
+      /**
+       * If true, the new credits purchase invoice will be marked as paid.
+       */
+      mark_as_paid?: boolean;
+
       /**
        * An optional memo to display on the invoice.
        */
@@ -1265,7 +1293,8 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
        * based on the invoice or issuance date, depending on the account's configured due
        * date calculation method. A value of '0' here represents that the invoice is due
        * on issue, whereas a value of '30' represents that the customer has 30 days to
-       * pay the invoice. Do not set this field if you want to set a custom due date.
+       * pay the invoice. You must set either `net_terms` or `custom_due_date`, but not
+       * both.
        */
       net_terms?: number | null;
 

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

@@ -5,6 +5,9 @@ import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
 import { Page, type PageParams } from '../../../pagination';
 
+/**
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+ */
 export class TopUps extends APIResource {
   /**
    * This endpoint allows you to create a new top-up for a specified customer's

package/src/resources/customers/customers.ts

@@ -33,6 +33,22 @@ import {
 } from './credits/credits';
 import { Page, type PageParams } from '../../pagination';
 
+/**
+ * A customer is a buyer of your products, and the other party to the billing relationship.
+ *
+ * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
+ * match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
+ * `external_customer_id` with your own identifier. See
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
+ * aliases work in Orb.
+ *
+ * In addition to having an identifier in your system, a customer may exist in a payment provider solution like
+ * Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
+ *
+ * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
+ * defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
+ * information on what this timezone parameter influences within Orb.
+ */
 export class Customers extends APIResource {
   costs: CostsAPI.Costs = new CostsAPI.Costs(this._client);
   credits: CreditsAPI.Credits = new CreditsAPI.Credits(this._client);
@@ -60,9 +76,10 @@ export class Customers extends APIResource {
   /**
    * This endpoint can be used to update the `payment_provider`,
    * `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
-   * `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
-   * `additional_emails` of an existing customer. Other fields on a customer are
-   * currently immutable.
+   * `auto_collection`, `metadata`, `shipping_address`, `billing_address`,
+   * `additional_emails`, and `currency` of an existing customer. `currency` can only
+   * be set if it has not already been set on the customer. Other fields on a
+   * customer are currently immutable.
    */
   update(
     customerId: string,
@@ -292,7 +309,14 @@ export interface Customer {
    * When not in test mode, the connection must first be configured in the Orb
    * webapp.
    */
-  payment_provider: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
+  payment_provider:
+    | 'quickbooks'
+    | 'bill.com'
+    | 'stripe_charge'
+    | 'stripe_invoice'
+    | 'netsuite'
+    | 'netsuite_ampersand'
+    | null;
 
   /**
    * The ID of this customer in an external payments solution, such as Stripe. This
@@ -497,7 +521,7 @@ export namespace Customer {
     export interface AccountingProvider {
       external_provider_id: string | null;
 
-      provider_type: 'quickbooks' | 'netsuite';
+      provider_type: 'quickbooks' | 'netsuite' | 'netsuite_ampersand';
     }
   }
 
@@ -674,7 +698,14 @@ export interface CustomerCreateParams {
    * When not in test mode, the connection must first be configured in the Orb
    * webapp.
    */
-  payment_provider?: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
+  payment_provider?:
+    | 'quickbooks'
+    | 'bill.com'
+    | 'stripe_charge'
+    | 'stripe_invoice'
+    | 'netsuite'
+    | 'netsuite_ampersand'
+    | null;
 
   /**
    * The ID of this customer in an external payments solution, such as Stripe. This
@@ -947,8 +978,10 @@ export interface CustomerUpdateParams {
   billing_address?: AddressInput | null;
 
   /**
-   * An ISO 4217 currency string used for the customer's invoices and balance. If not
-   * set at creation time, will be set at subscription creation time.
+   * An ISO 4217 currency string used for the customer's invoices and balance. This
+   * can only be set if the customer does not already have a currency configured. If
+   * not set at creation or update time, it will be set at subscription creation
+   * time.
    */
   currency?: string | null;
 
@@ -1000,7 +1033,14 @@ export interface CustomerUpdateParams {
    *   `bill.com`, `netsuite`), any product mappings must first be configured with
    *   the Orb team.
    */
-  payment_provider?: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
+  payment_provider?:
+    | 'quickbooks'
+    | 'bill.com'
+    | 'stripe_charge'
+    | 'stripe_invoice'
+    | 'netsuite'
+    | 'netsuite_ampersand'
+    | null;
 
   /**
    * The ID of this customer in an external payments solution, such as Stripe. This
@@ -1276,8 +1316,10 @@ export interface CustomerUpdateByExternalIDParams {
   billing_address?: AddressInput | null;
 
   /**
-   * An ISO 4217 currency string used for the customer's invoices and balance. If not
-   * set at creation time, will be set at subscription creation time.
+   * An ISO 4217 currency string used for the customer's invoices and balance. This
+   * can only be set if the customer does not already have a currency configured. If
+   * not set at creation or update time, it will be set at subscription creation
+   * time.
    */
   currency?: string | null;
 
@@ -1329,7 +1371,14 @@ export interface CustomerUpdateByExternalIDParams {
    *   `bill.com`, `netsuite`), any product mappings must first be configured with
    *   the Orb team.
    */
-  payment_provider?: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
+  payment_provider?:
+    | 'quickbooks'
+    | 'bill.com'
+    | 'stripe_charge'
+    | 'stripe_invoice'
+    | 'netsuite'
+    | 'netsuite_ampersand'
+    | null;
 
   /**
    * The ID of this customer in an external payments solution, such as Stripe. This

package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts

@@ -42,7 +42,7 @@ export interface ExternalDimensionalPriceGroupIDUpdateParams {
    * field to identify a dimensional price group by an existing identifier in your
    * system.
    */
-  body_external_dimensional_price_group_id?: string | null;
+  external_dimensional_price_group_id?: string | null;
 
   /**
    * User-specified key/value pairs for the resource. Individual keys can be removed

package/src/resources/events/backfills.ts

@@ -5,6 +5,11 @@ import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
 import { Page, type PageParams } from '../../pagination';
 
+/**
+ * The [Event](/core-concepts#event) resource represents a usage event that has been created for a
+ * customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
+ * a given billing period.
+ */
 export class Backfills extends APIResource {
   /**
    * Creating the backfill enables adding or replacing past events, even those that

package/src/resources/events/events.ts

@@ -17,6 +17,11 @@ import {
 import * as VolumeAPI from './volume';
 import { EventVolumes, Volume, VolumeListParams } from './volume';
 
+/**
+ * The [Event](/core-concepts#event) resource represents a usage event that has been created for a
+ * customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
+ * a given billing period.
+ */
 export class Events extends APIResource {
   backfills: BackfillsAPI.Backfills = new BackfillsAPI.Backfills(this._client);
   volume: VolumeAPI.Volume = new VolumeAPI.Volume(this._client);

package/src/resources/events/volume.ts

@@ -3,6 +3,11 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 
+/**
+ * The [Event](/core-concepts#event) resource represents a usage event that has been created for a
+ * customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
+ * a given billing period.
+ */
 export class Volume extends APIResource {
   /**
    * This endpoint returns the event volume for an account in a

package/src/resources/index.ts

@@ -36,7 +36,11 @@ export {
   type CouponCreateParams,
   type CouponListParams,
 } from './coupons/coupons';
-export { CreditBlocks, type CreditBlockRetrieveResponse } from './credit-blocks';
+export {
+  CreditBlocks,
+  type CreditBlockRetrieveResponse,
+  type CreditBlockListInvoicesResponse,
+} from './credit-blocks';
 export { CreditNotes, type CreditNoteCreateParams, type CreditNoteListParams } from './credit-notes';
 export {
   CustomersPage,
@@ -82,12 +86,14 @@ export {
   InvoiceListSummaryResponsesPage,
   Invoices,
   type InvoiceFetchUpcomingResponse,
+  type InvoiceIssueSummaryResponse,
   type InvoiceListSummaryResponse,
   type InvoiceCreateParams,
   type InvoiceUpdateParams,
   type InvoiceListParams,
   type InvoiceFetchUpcomingParams,
   type InvoiceIssueParams,
+  type InvoiceIssueSummaryParams,
   type InvoiceListSummaryParams,
   type InvoiceMarkPaidParams,
 } from './invoices';
@@ -99,6 +105,28 @@ export {
   type ItemUpdateParams,
   type ItemListParams,
 } from './items';
+export {
+  LicenseListResponsesPage,
+  Licenses,
+  type LicenseCreateResponse,
+  type LicenseRetrieveResponse,
+  type LicenseListResponse,
+  type LicenseDeactivateResponse,
+  type LicenseRetrieveByExternalIDResponse,
+  type LicenseCreateParams,
+  type LicenseListParams,
+  type LicenseDeactivateParams,
+  type LicenseRetrieveByExternalIDParams,
+} from './licenses/licenses';
+export {
+  LicenseTypeListResponsesPage,
+  LicenseTypes,
+  type LicenseTypeCreateResponse,
+  type LicenseTypeRetrieveResponse,
+  type LicenseTypeListResponse,
+  type LicenseTypeCreateParams,
+  type LicenseTypeListParams,
+} from './license-types';
 export {
   PlansPage,
   Plans,

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

@@ -4,6 +4,12 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 import * as Shared from './shared';
 
+/**
+ * An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for
+ * a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and
+ * can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as
+ * the result of an action, such as a cancellation.
+ */
 export class InvoiceLineItems extends APIResource {
   /**
    * This creates a one-off fixed fee invoice line item on an Invoice. This can only