@openmeter/client 1.0.0-beta.231 → 1.0.0-beta.232

package/dist/models/types.d.ts

@@ -43,11 +43,11 @@ export interface CursorMetaPage {
     /** URI to the last page. */
     last?: string;
     /** URI to the next page. */
-    next?: string;
+    next: string | null;
     /** URI to the previous page. */
-    previous?: string;
+    previous: string | null;
     /** Requested page size. */
-    size?: number;
+    size: number;
 }
 /** Standard error response. */
 export interface BaseError {
@@ -188,6 +188,52 @@ export interface RateCardBooleanEntitlement {
     /** The type of the entitlement template. */
     type: 'boolean';
 }
+/**
+ * Labels store metadata of an entity that can be used for filtering an entity list
+ * or for searching across entity types.
+ *
+ * Keys must be of length 1-63 characters, and cannot start with "kong", "konnect",
+ * "mesh", "kic", or "\_".
+ */
+export type UpdateLabels = Record<string, string>;
+/** Model for installing an app from the catalog with an API key. */
+export interface InstallAppStripeWithApiKey {
+    /** Type of the app. */
+    type: 'stripe';
+    /** Name of the app. */
+    name: string;
+    /**
+     * If true, a billing profile will be created for the app. The Stripe app will be
+     * also set as the default billing profile if the current default is a Sandbox app.
+     */
+    createBillingProfile: boolean;
+    /** API key for the app. */
+    apiKey: string;
+}
+/** Base model for installing an app from the catalog. */
+export interface InstallAppSandbox {
+    /** Type of the app. */
+    type: 'sandbox';
+    /** Name of the app. */
+    name: string;
+    /**
+     * If true, a billing profile will be created for the app. The Stripe app will be
+     * also set as the default billing profile if the current default is a Sandbox app.
+     */
+    createBillingProfile: boolean;
+}
+/** Base model for installing an app from the catalog. */
+export interface InstallAppExternalInvoicing {
+    /** Type of the app. */
+    type: 'external_invoicing';
+    /** Name of the app. */
+    name: string;
+    /**
+     * If true, a billing profile will be created for the app. The Stripe app will be
+     * also set as the default billing profile if the current default is a Sandbox app.
+     */
+    createBillingProfile: boolean;
+}
 /**
  * BillingWorkflowCollectionAlignmentSubscription specifies the alignment for
  * collecting the pending line items into an invoice.
@@ -249,14 +295,6 @@ export interface InvoiceLineExternalReferences {
     /** The ID assigned by the external invoicing app. */
     invoicingId?: string;
 }
-/**
- * Labels store metadata of an entity that can be used for filtering an entity list
- * or for searching across entity types.
- *
- * Keys must be of length 1-63 characters, and cannot start with "kong", "konnect",
- * "mesh", "kic", or "\_".
- */
-export type UpdateLabels = Record<string, string>;
 /**
  * Invoice-level invoicing settings.
  *
@@ -484,6 +522,22 @@ export interface CurrencyFiat {
      * the currency, such as "$" for US Dollar or "€" for Euro.
      */
     symbol?: string;
+    /**
+     * The precision of the currency. It should be a number that represents the number
+     * of decimal places used for the currency, such as 2 for US Dollar or Euro.
+     */
+    precision: number;
+    /**
+     * The decimal mark for the currency. It should be a string that represents the
+     * decimal mark of the currency, such as "." for US Dollar or "," for Euro.
+     */
+    decimalMark: string;
+    /**
+     * The thousand separator for the currency. It should be a string that represents
+     * the thousand separator of the currency, such as "," for US Dollar or "." for
+     * Euro.
+     */
+    thousandSeparator: string;
     code: string;
 }
 /** Filter options for listing cost bases. */
@@ -491,6 +545,36 @@ export interface ListCostBasesParamsFilter {
     /** Filter cost bases by fiat currency code. */
     fiatCode?: string;
 }
+/** CurrencyCustom create request. */
+export interface CreateCurrencyCustomRequest {
+    /**
+     * The name of the currency. It should be a human-readable string that represents
+     * the name of the currency, such as "US Dollar" or "Euro".
+     */
+    name: string;
+    /**
+     * The symbol of the currency. It should be a string that represents the symbol of
+     * the currency, such as "$" for US Dollar or "€" for Euro.
+     */
+    symbol?: string;
+    /**
+     * The precision of the currency. It should be a number that represents the number
+     * of decimal places used for the currency, such as 2 for US Dollar or Euro.
+     */
+    precision: number;
+    /**
+     * The decimal mark for the currency. It should be a string that represents the
+     * decimal mark of the currency, such as "." for US Dollar or "," for Euro.
+     */
+    decimalMark: string;
+    /**
+     * The thousand separator for the currency. It should be a string that represents
+     * the thousand separator of the currency, such as "," for US Dollar or "." for
+     * Euro.
+     */
+    thousandSeparator: string;
+    code: string;
+}
 /** Monetary amount in a specific currency. */
 export interface CurrencyAmount {
     amount: string;
@@ -1514,9 +1598,10 @@ export interface CreateCreditGrantPurchase {
     /**
      * Cost basis per credit unit used to calculate the purchase amount.
      *
-     * If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
-     * is $50.00. The value must be greater than 0. If the cost basis is 0, use
-     * `funding_method=none` instead.
+     * If `per_unit_cost_basis` is 0.50 and credit amount is
+     * $100.00, the total
+     * charge is $50.00. The value must be greater than 0. If the
+     * cost basis is 0, use `funding_method=none` instead.
      *
      * Defaults to 1.0.
      */
@@ -1564,9 +1649,10 @@ export interface CreditGrantPurchase {
     /**
      * Cost basis per credit unit used to calculate the purchase amount.
      *
-     * If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
-     * is $50.00. The value must be greater than 0. If the cost basis is 0, use
-     * `funding_method=none` instead.
+     * If `per_unit_cost_basis` is 0.50 and credit amount is
+     * $100.00, the total
+     * charge is $50.00. The value must be greater than 0. If the
+     * cost basis is 0, use `funding_method=none` instead.
      *
      * Defaults to 1.0.
      */
@@ -1781,20 +1867,6 @@ export interface UnitConfig {
      */
     displayUnit?: string;
 }
-/**
- * Available apps for billing integrations to connect with third-party services.
- * Apps can have various capabilities like syncing data from or to external
- * systems, integrating with third-party services for tax calculation, delivery of
- * invoices, collection of payments, etc.
- */
-export interface AppCatalogItem {
-    /** Type of the app. */
-    type: 'sandbox' | 'stripe' | 'external_invoicing';
-    /** Name of the app. */
-    name: string;
-    /** Description of the app. */
-    description: string;
-}
 /** Mapping of app types to tax codes. */
 export interface TaxCodeAppMapping {
     /** The app type that the tax code is associated with. */
@@ -1802,6 +1874,97 @@ export interface TaxCodeAppMapping {
     /** Tax code. */
     taxCode: string;
 }
+/** App capability describes a function that an App can perform. */
+export interface AppCapability {
+    /** Type of the capability. */
+    type: 'report_usage' | 'report_events' | 'calculate_tax' | 'invoice_customers' | 'collect_payments';
+    /** Key of the capability. */
+    key: string;
+    /** Name of the capability. */
+    name: string;
+    /** Description of the capability. */
+    description: string;
+}
+/** AppStripe update request. */
+export interface UpdateAppStripeRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: UpdateLabels;
+    /** The app type. */
+    type: 'stripe';
+    /** The Stripe secret API key used to authenticate API requests. */
+    secretApiKey?: string;
+}
+/** AppSandbox update request. */
+export interface UpdateAppSandboxRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: UpdateLabels;
+    /** The app type. */
+    type: 'sandbox';
+}
+/** AppExternalInvoicing update request. */
+export interface UpdateAppExternalInvoicingRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: UpdateLabels;
+    /** The app type. */
+    type: 'external_invoicing';
+    /**
+     * Enable draft synchronization hook.
+     *
+     * When enabled, invoices will pause at the draft state and wait for the
+     * integration to call the draft synchronized endpoint before progressing to the
+     * issuing state. This allows the external system to validate and prepare the
+     * invoice data.
+     *
+     * When disabled, invoices automatically progress through the draft state based on
+     * the configured workflow timing.
+     */
+    enableDraftSyncHook: boolean;
+    /**
+     * Enable issuing synchronization hook.
+     *
+     * When enabled, invoices will pause at the issuing state and wait for the
+     * integration to call the issuing synchronized endpoint before progressing to the
+     * issued state. This ensures the external invoicing system has successfully
+     * created and finalized the invoice before it is marked as issued.
+     *
+     * When disabled, invoices automatically progress through the issuing state and are
+     * immediately marked as issued.
+     */
+    enableIssuingSyncHook: boolean;
+}
 /**
  * Identity stores the details required to identify an entity for tax purposes in a
  * specific country.
@@ -1912,39 +2075,6 @@ export interface ListCurrenciesParamsFilter {
     type?: 'fiat' | 'custom';
     code?: StringFieldFilter;
 }
-/** Describes custom currency. */
-export interface CurrencyCustom {
-    /** The type of the currency. */
-    type: 'custom';
-    /**
-     * The name of the currency. It should be a human-readable string that represents
-     * the name of the currency, such as "US Dollar" or "Euro".
-     */
-    name: string;
-    /**
-     * The symbol of the currency. It should be a string that represents the symbol of
-     * the currency, such as "$" for US Dollar or "€" for Euro.
-     */
-    symbol?: string;
-    id: string;
-    code: string;
-    /** An ISO-8601 timestamp representation of the custom currency creation date. */
-    createdAt: Date;
-}
-/** CurrencyCustom create request. */
-export interface CreateCurrencyCustomRequest {
-    /**
-     * The name of the currency. It should be a human-readable string that represents
-     * the name of the currency, such as "US Dollar" or "Euro".
-     */
-    name: string;
-    /**
-     * The symbol of the currency. It should be a string that represents the symbol of
-     * the currency, such as "$" for US Dollar or "€" for Euro.
-     */
-    symbol?: string;
-    code: string;
-}
 /** Query to evaluate feature access for a list of customers. */
 export interface GovernanceQueryRequest {
     /**
@@ -2017,7 +2147,12 @@ export interface CreditAdjustment {
 /** The credit balance by currency. */
 export interface CreditBalance {
     currency: BillingCurrencyCode;
-    /** Credits available after applying currently live charge impacts. */
+    /**
+     * Credits available after applying currently live charge impacts.
+     *
+     * Always zero for historical balance queries using the `timestamp` parameter
+     * because live charge impacts cannot be reconstructed historically.
+     */
     live: string;
     /** Credits that have been booked on the ledger as of the balance timestamp. */
     settled: string;
@@ -2524,6 +2659,46 @@ export interface MeterQueryResult {
     /** The usage data. If no data is available, an empty array is returned. */
     data: MeterQueryRow[];
 }
+/** Describes custom currency. */
+export interface CurrencyCustom {
+    /** The type of the currency. */
+    type: 'custom';
+    /**
+     * The name of the currency. It should be a human-readable string that represents
+     * the name of the currency, such as "US Dollar" or "Euro".
+     */
+    name: string;
+    /**
+     * The symbol of the currency. It should be a string that represents the symbol of
+     * the currency, such as "$" for US Dollar or "€" for Euro.
+     */
+    symbol?: string;
+    /**
+     * The precision of the currency. It should be a number that represents the number
+     * of decimal places used for the currency, such as 2 for US Dollar or Euro.
+     */
+    precision: number;
+    /**
+     * The decimal mark for the currency. It should be a string that represents the
+     * decimal mark of the currency, such as "." for US Dollar or "," for Euro.
+     */
+    decimalMark: string;
+    /**
+     * The thousand separator for the currency. It should be a string that represents
+     * the thousand separator of the currency, such as "," for US Dollar or "." for
+     * Euro.
+     */
+    thousandSeparator: string;
+    id: string;
+    code: string;
+    /** An ISO-8601 timestamp representation of the custom currency creation date. */
+    createdAt: Date;
+    /**
+     * The list of active and scheduled cost bases for the custom currency. Expired and
+     * deleted cost bases are excluded.
+     */
+    costBasis?: CostBasis[];
+}
 /** Result of a feature cost query. */
 export interface FeatureCostQueryResult {
     /** Start of the queried period. */
@@ -2847,159 +3022,24 @@ export interface CreateSubscriptionAddonRequest {
  * Usage quantity details on an invoice line item when UnitConfig is in effect.
  *
  * Provides the full audit trail from raw meter output to the invoiced amount.
- */
-export interface InvoiceUsageQuantityDetail {
-    /** The raw quantity as reported by the meter (native units). */
-    rawQuantity: string;
-    /**
-     * The precise decimal value after applying the conversion operation and factor,
-     * before rounding.
-     */
-    convertedQuantity: string;
-    /** The quantity after rounding, used for pricing. */
-    invoicedQuantity: string;
-    /** The display unit label (e.g., "GB", "hours", "M tokens"). */
-    displayUnit?: string;
-    /**
-     * Snapshot of the UnitConfig that was in effect at billing time. Ensures
-     * historical invoices reflect the config that was actually applied.
-     */
-    appliedUnitConfig: UnitConfig;
-}
-/** Stripe app. */
-export interface AppStripe {
-    id: string;
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The app type. */
-    type: 'stripe';
-    /** The app catalog definition that this installed app is based on. */
-    definition: AppCatalogItem;
-    /** Status of the app connection. */
-    status: 'ready' | 'unauthorized';
-    /** The Stripe account ID associated with the connected Stripe account. */
-    accountId: string;
-    /** Indicates whether the app is connected to a live Stripe account. */
-    livemode: boolean;
-    /** The masked Stripe API key that only exposes the first and last few characters. */
-    maskedApiKey: string;
-}
-/** Sandbox app can be used for testing billing features. */
-export interface AppSandbox {
-    id: string;
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The app type. */
-    type: 'sandbox';
-    /** The app catalog definition that this installed app is based on. */
-    definition: AppCatalogItem;
-    /** Status of the app connection. */
-    status: 'ready' | 'unauthorized';
-}
-/**
- * External Invoicing app enables integration with third-party invoicing or payment
- * system.
- *
- * The app supports a bi-directional synchronization pattern where OpenMeter
- * Billing manages the invoice lifecycle while the external system handles invoice
- * presentation and payment collection.
- *
- * Integration workflow:
- *
- * 1. The billing system creates invoices and transitions them through lifecycle
- * states (draft → issuing → issued)
- * 2. The integration receives webhook notifications about invoice state changes
- * 3. The integration calls back to provide external system IDs and metadata
- * 4. The integration reports payment events back via the payment status API
- *
- * State synchronization is controlled by hooks that pause invoice progression
- * until the external system confirms synchronization via API callbacks.
- */
-export interface AppExternalInvoicing {
-    id: string;
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The app type. */
-    type: 'external_invoicing';
-    /** The app catalog definition that this installed app is based on. */
-    definition: AppCatalogItem;
-    /** Status of the app connection. */
-    status: 'ready' | 'unauthorized';
-    /**
-     * Enable draft synchronization hook.
-     *
-     * When enabled, invoices will pause at the draft state and wait for the
-     * integration to call the draft synchronized endpoint before progressing to the
-     * issuing state. This allows the external system to validate and prepare the
-     * invoice data.
-     *
-     * When disabled, invoices automatically progress through the draft state based on
-     * the configured workflow timing.
+ */
+export interface InvoiceUsageQuantityDetail {
+    /** The raw quantity as reported by the meter (native units). */
+    rawQuantity: string;
+    /**
+     * The precise decimal value after applying the conversion operation and factor,
+     * before rounding.
      */
-    enableDraftSyncHook: boolean;
+    convertedQuantity: string;
+    /** The quantity after rounding, used for pricing. */
+    invoicedQuantity: string;
+    /** The display unit label (e.g., "GB", "hours", "M tokens"). */
+    displayUnit?: string;
     /**
-     * Enable issuing synchronization hook.
-     *
-     * When enabled, invoices will pause at the issuing state and wait for the
-     * integration to call the issuing synchronized endpoint before progressing to the
-     * issued state. This ensures the external invoicing system has successfully
-     * created and finalized the invoice before it is marked as issued.
-     *
-     * When disabled, invoices automatically progress through the issuing state and are
-     * immediately marked as issued.
+     * Snapshot of the UnitConfig that was in effect at billing time. Ensures
+     * historical invoices reflect the config that was actually applied.
      */
-    enableIssuingSyncHook: boolean;
+    appliedUnitConfig: UnitConfig;
 }
 /** TaxCode create request. */
 export interface CreateTaxCodeRequest {
@@ -3064,6 +3104,24 @@ export interface UpsertTaxCodeRequest {
     /** Mapping of app types to tax codes. */
     appMappings: TaxCodeAppMapping[];
 }
+/**
+ * Available apps for billing integrations to connect with third-party services.
+ * Apps can have various capabilities like syncing data from or to external
+ * systems, integrating with third-party services for tax calculation, delivery of
+ * invoices, collection of payments, etc.
+ */
+export interface AppCatalogItem {
+    /** Type of the app. */
+    type: 'sandbox' | 'stripe' | 'external_invoicing';
+    /** Name of the app. */
+    name: string;
+    /** Description of the app. */
+    description: string;
+    /** Capabilities of the app. */
+    capabilities: AppCapability[];
+    /** Available install methods of the app. */
+    installMethods: ('with_oauth2' | 'with_api_key' | 'no_credentials_required')[];
+}
 /**
  * Invoice-level snapshot of the workflow configuration.
  *
@@ -3277,8 +3335,9 @@ export interface CreateCreditGrantRequest {
     /**
      * Idempotency key for the credit grant creation request.
      *
-     * When provided, reusing the same key returns an HTTP 409 Conflict instead of
-     * creating a duplicate grant, which makes create requests safe to retry.
+     * Unique per customer: reusing the same key for the same customer returns an HTTP
+     * 409 Conflict instead of creating a duplicate grant, which makes create requests
+     * safe to retry. The same key may be reused across different customers.
      */
     key?: string;
 }
@@ -3340,8 +3399,9 @@ export interface CreditGrant {
     /**
      * Idempotency key for the credit grant creation request.
      *
-     * When provided, reusing the same key returns an HTTP 409 Conflict instead of
-     * creating a duplicate grant, which makes create requests safe to retry.
+     * Unique per customer: reusing the same key for the same customer returns an HTTP
+     * 409 Conflict instead of creating a duplicate grant, which makes create requests
+     * safe to retry. The same key may be reused across different customers.
      */
     key?: string;
     /**
@@ -3616,6 +3676,146 @@ export interface TaxCodePagePaginatedResponse {
     data: TaxCode[];
     meta: PaginatedMeta;
 }
+/** Stripe app. */
+export interface AppStripe {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The app type. */
+    type: 'stripe';
+    /** The app catalog definition that this installed app is based on. */
+    definition: AppCatalogItem;
+    /** Status of the app connection. */
+    status: 'ready' | 'unauthorized';
+    /** The Stripe account ID associated with the connected Stripe account. */
+    accountId: string;
+    /** Indicates whether the app is connected to a live Stripe account. */
+    livemode: boolean;
+    /** The masked Stripe API key that only exposes the first and last few characters. */
+    maskedApiKey: string;
+}
+/** Sandbox app can be used for testing billing features. */
+export interface AppSandbox {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The app type. */
+    type: 'sandbox';
+    /** The app catalog definition that this installed app is based on. */
+    definition: AppCatalogItem;
+    /** Status of the app connection. */
+    status: 'ready' | 'unauthorized';
+}
+/**
+ * External Invoicing app enables integration with third-party invoicing or payment
+ * system.
+ *
+ * The app supports a bi-directional synchronization pattern where OpenMeter
+ * Billing manages the invoice lifecycle while the external system handles invoice
+ * presentation and payment collection.
+ *
+ * Integration workflow:
+ *
+ * 1. The billing system creates invoices and transitions them through lifecycle
+ * states (draft → issuing → issued)
+ * 2. The integration receives webhook notifications about invoice state changes
+ * 3. The integration calls back to provide external system IDs and metadata
+ * 4. The integration reports payment events back via the payment status API
+ *
+ * State synchronization is controlled by hooks that pause invoice progression
+ * until the external system confirms synchronization via API callbacks.
+ */
+export interface AppExternalInvoicing {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The app type. */
+    type: 'external_invoicing';
+    /** The app catalog definition that this installed app is based on. */
+    definition: AppCatalogItem;
+    /** Status of the app connection. */
+    status: 'ready' | 'unauthorized';
+    /**
+     * Enable draft synchronization hook.
+     *
+     * When enabled, invoices will pause at the draft state and wait for the
+     * integration to call the draft synchronized endpoint before progressing to the
+     * issuing state. This allows the external system to validate and prepare the
+     * invoice data.
+     *
+     * When disabled, invoices automatically progress through the draft state based on
+     * the configured workflow timing.
+     */
+    enableDraftSyncHook: boolean;
+    /**
+     * Enable issuing synchronization hook.
+     *
+     * When enabled, invoices will pause at the issuing state and wait for the
+     * integration to call the issuing synchronized endpoint before progressing to the
+     * issued state. This ensures the external invoicing system has successfully
+     * created and finalized the invoice before it is marked as issued.
+     *
+     * When disabled, invoices automatically progress through the issuing state and are
+     * immediately marked as issued.
+     */
+    enableIssuingSyncHook: boolean;
+}
+/** Page paginated response. */
+export interface AppCatalogItemPagePaginatedResponse {
+    data: AppCatalogItem[];
+    meta: PaginatedMeta;
+}
 /** Snapshot of the billing workflow configuration captured at invoice creation. */
 export interface InvoiceWorkflowSettings {
     /** The apps that will be used to orchestrate the invoice's workflow. */
@@ -3688,11 +3888,6 @@ export interface UpdateInvoiceWorkflowSettings {
      */
     workflow: UpdateBillingInvoiceWorkflow;
 }
-/** Page paginated response. */
-export interface CurrencyPagePaginatedResponse {
-    data: Currency[];
-    meta: PaginatedMeta;
-}
 /** Access evaluation result for a single resolved customer. */
 export interface GovernanceQueryResult {
     /**
@@ -3800,6 +3995,11 @@ export interface CreditGrantPagePaginatedResponse {
     data: CreditGrant[];
     meta: PaginatedMeta;
 }
+/** Page paginated response. */
+export interface CurrencyPagePaginatedResponse {
+    data: Currency[];
+    meta: PaginatedMeta;
+}
 /** Bad Request. */
 export interface BadRequest extends BaseError {
     /** The list of parameters that failed validation. */
@@ -3888,20 +4088,6 @@ export interface WorkflowCollectionSettings {
      */
     interval: string;
 }
-/** Page paginated response. */
-export interface AppPagePaginatedResponse {
-    data: App[];
-    meta: PaginatedMeta;
-}
-/** Applications used by a billing profile. */
-export interface ProfileApps {
-    /** The tax app used for this workflow. */
-    tax: App;
-    /** The invoicing app used for this workflow. */
-    invoicing: App;
-    /** The payment app used for this workflow. */
-    payment: App;
-}
 /** Response of the governance query. */
 export interface GovernanceQueryResponse {
     /** Access evaluation results, one entry per resolved customer. */
@@ -4086,6 +4272,11 @@ export interface RateCard {
     key: string;
     /** The feature associated with the rate card. */
     feature?: FeatureReference;
+    /**
+     * Overrides the containing plan or add-on currency for this rate card. When
+     * omitted, the containing resource currency applies.
+     */
+    currency?: BillingCurrencyCode;
     /**
      * The billing cadence of the rate card. When null, the charge is one-time
      * (non-recurring). Only valid for flat prices.
@@ -4134,6 +4325,11 @@ export interface InvoiceLineRateCard {
     featureKey?: string;
     /** Discount configuration from the rate card. */
     discounts?: RateCardDiscounts;
+    /**
+     * Unit config snapshot applied when this line was billed, converting the raw
+     * metered quantity into the billed quantity. Frozen at billing time; read-only.
+     */
+    unitConfig?: UnitConfig;
 }
 /** Rate card configuration snapshot for a usage-based invoice line. */
 export interface UpdateInvoiceLineRateCard {
@@ -4162,6 +4358,25 @@ export interface Workflow {
     /** The tax settings for this workflow */
     tax?: WorkflowTaxSettings;
 }
+/** Page paginated response. */
+export interface AppPagePaginatedResponse {
+    data: App[];
+    meta: PaginatedMeta;
+}
+/** Response of the app install. */
+export interface BillingInstallAppResponse {
+    app: App;
+    defaultForCapabilityTypes: ('report_usage' | 'report_events' | 'calculate_tax' | 'invoice_customers' | 'collect_payments')[];
+}
+/** Applications used by a billing profile. */
+export interface ProfileApps {
+    /** The tax app used for this workflow. */
+    tax: App;
+    /** The invoicing app used for this workflow. */
+    invoicing: App;
+    /** The payment app used for this workflow. */
+    payment: App;
+}
 /** A usage-based charge for a customer. */
 export interface ChargeUsageBased {
     id: string;
@@ -4655,7 +4870,7 @@ export interface Plan {
      */
     version: number;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */
@@ -4723,7 +4938,7 @@ export interface CreatePlanRequest {
      */
     key: string;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */
@@ -4934,9 +5149,9 @@ export type StringFieldFilterExact = string | {
 /** The payment term of a flat price. */
 export type PricePaymentTerm = 'in_advance' | 'in_arrears';
 /** Fiat or custom currency code. */
-export type BillingCurrencyCode = string;
+export type BillingCurrencyCode = string | string;
 /** Fiat or custom currency code. */
-export type CreateCurrencyCode = string;
+export type CreateCurrencyCode = string | string;
 /**
  * Filters on the given ULID field value by exact match. All properties are
  * optional; provide exactly one to specify the comparison.
@@ -4963,6 +5178,8 @@ export type DateTimeFieldFilter = Date | {
  * returned.
  */
 export type SubscriptionEditTiming = 'immediate' | 'next_billing_cycle' | Date;
+/** Request to install an app from the catalog. */
+export type InstallAppRequest = InstallAppStripeWithApiKey | InstallAppSandbox | InstallAppExternalInvoicing;
 /** Payment settings for a billing workflow. */
 export type WorkflowPaymentSettings = WorkflowPaymentChargeAutomaticallySettings | WorkflowPaymentSendInvoiceSettings;
 /** Payment settings for a billing workflow. */
@@ -4974,13 +5191,15 @@ export type InvalidParameter = InvalidParameterStandard | InvalidParameterMinimu
  * rate card itself, so it is omitted here.
  */
 export type RateCardEntitlement = RateCardMeteredEntitlement | RateCardStaticEntitlement | RateCardBooleanEntitlement;
-/** Fiat or custom currency. */
-export type Currency = CurrencyFiat | CurrencyCustom;
+/** Request to update an installed app. */
+export type UpdateAppRequest = UpdateAppStripeRequest | UpdateAppSandboxRequest | UpdateAppExternalInvoicingRequest;
 /**
  * Per-unit cost configuration for a feature. Either a fixed manual amount or a
  * dynamic LLM cost lookup.
  */
 export type FeatureUnitCost = FeatureManualUnitCost | FeatureLlmUnitCost;
+/** Fiat or custom currency. */
+export type Currency = CurrencyFiat | CurrencyCustom;
 /**
  * The alignment for collecting the pending line items into an invoice.
  *
@@ -4989,12 +5208,12 @@ export type FeatureUnitCost = FeatureManualUnitCost | FeatureLlmUnitCost;
  * arrears items).
  */
 export type WorkflowCollectionAlignment = WorkflowCollectionAlignmentSubscription | WorkflowCollectionAlignmentAnchored;
-/** Installed application. */
-export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Price. */
 export type Price = PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
 /** Price. */
 export type UpdatePrice = UpdatePriceFree | UpdatePriceFlat | UpdatePriceUnit | UpdatePriceGraduated | UpdatePriceVolume;
+/** Installed application. */
+export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Customer charge. */
 export type CreateChargeRequest = CreateChargeFlatFeeRequest | CreateChargeUsageBasedRequest;
 /** Customer charge. */
@@ -5217,9 +5436,10 @@ export interface CreateCreditGrantPurchaseInput {
     /**
      * Cost basis per credit unit used to calculate the purchase amount.
      *
-     * If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
-     * is $50.00. The value must be greater than 0. If the cost basis is 0, use
-     * `funding_method=none` instead.
+     * If `per_unit_cost_basis` is 0.50 and credit amount is
+     * $100.00, the total
+     * charge is $50.00. The value must be greater than 0. If the
+     * cost basis is 0, use `funding_method=none` instead.
      *
      * Defaults to 1.0.
      */
@@ -5260,9 +5480,10 @@ export interface CreditGrantPurchaseInput {
     /**
      * Cost basis per credit unit used to calculate the purchase amount.
      *
-     * If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
-     * is $50.00. The value must be greater than 0. If the cost basis is 0, use
-     * `funding_method=none` instead.
+     * If `per_unit_cost_basis` is 0.50 and credit amount is
+     * $100.00, the total
+     * charge is $50.00. The value must be greater than 0. If the
+     * cost basis is 0, use `funding_method=none` instead.
      *
      * Defaults to 1.0.
      */
@@ -5487,8 +5708,9 @@ export interface CreateCreditGrantRequestInput {
     /**
      * Idempotency key for the credit grant creation request.
      *
-     * When provided, reusing the same key returns an HTTP 409 Conflict instead of
-     * creating a duplicate grant, which makes create requests safe to retry.
+     * Unique per customer: reusing the same key for the same customer returns an HTTP
+     * 409 Conflict instead of creating a duplicate grant, which makes create requests
+     * safe to retry. The same key may be reused across different customers.
      */
     key?: string;
 }
@@ -5550,8 +5772,9 @@ export interface CreditGrantInput {
     /**
      * Idempotency key for the credit grant creation request.
      *
-     * When provided, reusing the same key returns an HTTP 409 Conflict instead of
-     * creating a duplicate grant, which makes create requests safe to retry.
+     * Unique per customer: reusing the same key for the same customer returns an HTTP
+     * 409 Conflict instead of creating a duplicate grant, which makes create requests
+     * safe to retry. The same key may be reused across different customers.
      */
     key?: string;
     /**
@@ -5841,6 +6064,11 @@ export interface RateCardInput {
     key: string;
     /** The feature associated with the rate card. */
     feature?: FeatureReference;
+    /**
+     * Overrides the containing plan or add-on currency for this rate card. When
+     * omitted, the containing resource currency applies.
+     */
+    currency?: BillingCurrencyCode;
     /**
      * The billing cadence of the rate card. When null, the charge is one-time
      * (non-recurring). Only valid for flat prices.
@@ -5879,6 +6107,22 @@ export interface RateCardInput {
      */
     entitlement?: RateCardEntitlementInput;
 }
+/** Rate card configuration snapshot for a usage-based invoice line. */
+export interface InvoiceLineRateCardInput {
+    /** The price definition used to calculate charges for this line. */
+    price: Price;
+    /** Tax configuration snapshot for this line. */
+    taxConfig?: RateCardTaxConfig;
+    /** The feature key associated with this line's rate card. */
+    featureKey?: string;
+    /** Discount configuration from the rate card. */
+    discounts?: RateCardDiscounts;
+    /**
+     * Unit config snapshot applied when this line was billed, converting the raw
+     * metered quantity into the billed quantity. Frozen at billing time; read-only.
+     */
+    unitConfig?: UnitConfigInput;
+}
 /** Billing workflow settings. */
 export interface WorkflowInput {
     /** The collection settings for this workflow */
@@ -6094,7 +6338,7 @@ export interface InvoiceStandardLineInput {
     /** Reference to the subscription item that generated this line. */
     subscription?: SubscriptionReference;
     /** The rate card configuration snapshot used to price this line item. */
-    rateCard: InvoiceLineRateCard;
+    rateCard: InvoiceLineRateCardInput;
     /**
      * Detailed sub-lines that this line has been broken down into.
      *
@@ -6267,7 +6511,7 @@ export interface PlanInput {
      */
     version?: number;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */
@@ -6335,7 +6579,7 @@ export interface CreatePlanRequestInput {
      */
     key: string;
     /** The currency code of the plan. */
-    currency: string;
+    currency: BillingCurrencyCode;
     /** The billing cadence for subscriptions using this plan. */
     billingCadence: string;
     /** Whether pro-rating is enabled for this plan. */