@openmeter/client 1.0.0-beta.233 → 1.0.0-beta.235

package/dist/models/types.d.ts

@@ -147,6 +147,28 @@ export interface AppStripeCreateCustomerPortalSessionOptions {
  * "mesh", "kic", or "\_".
  */
 export type CreateLabels = Record<string, string>;
+/** An integer version comparison. Exactly one operator must be provided. */
+export interface CreateVersionFilter {
+    /** Match this exact version. */
+    eq?: number;
+    /** Match one of these versions. */
+    oeq?: number[];
+    /** Match this version and later versions. */
+    gte?: number;
+    /** Match this version and earlier versions. */
+    lte?: number;
+}
+/** An integer version comparison. Exactly one operator must be provided. */
+export interface VersionFilter {
+    /** Match this exact version. */
+    eq?: number;
+    /** Match one of these versions. */
+    oeq?: number[];
+    /** Match this version and later versions. */
+    gte?: number;
+    /** Match this version and earlier versions. */
+    lte?: number;
+}
 /** Free price. */
 export interface PriceFree {
     /** The type of the price. */
@@ -606,19 +628,58 @@ export interface CreateCurrencyCustomRequest {
     thousandSeparator: string;
     code: string;
 }
-/** Balance details of a metered entitlement. */
+/**
+ * Balance details of a metered entitlement at the evaluation time, which is the
+ * `at` query parameter when given and the current time otherwise.
+ */
 export interface EntitlementAccessValue {
-    /** The remaining balance of the entitlement in the current usage period. */
+    /**
+     * The remaining balance of the entitlement in the usage period at the evaluation
+     * time.
+     */
     balance: string;
-    /** The usage recorded in the current usage period. */
+    /** The usage recorded in the usage period at the evaluation time. */
     usage: string;
-    /** The usage exceeding the available balance in the current usage period. */
+    /**
+     * The usage exceeding the available balance in the usage period at the evaluation
+     * time.
+     */
     overage: string;
-    /** The total amount granted and currently available to the entitlement. */
+    /**
+     * The total amount granted and available to the entitlement at the evaluation
+     * time.
+     */
     totalAvailableGrantAmount: string;
     /** The remaining balance of each grant, keyed by grant ID. */
     grantBalances: Record<string, string>;
 }
+/**
+ * Usage granted automatically after each reset of a metered entitlement. The
+ * balance returns to `amount` after every reset.
+ */
+export interface EntitlementIssueAfterReset {
+    /** The amount granted after each reset, in the feature's unit. */
+    amount: string;
+    /**
+     * The priority of the grant created after each reset. Lower values have higher
+     * priority.
+     */
+    priority: number;
+}
+/** Entitlement balance at the boundaries of a burndown segment. */
+export interface EntitlementBurndownBalance {
+    /** The balance at the start of the segment. */
+    start: string;
+    /** The balance at the end of the segment. */
+    end: string;
+}
+/** Grant balances at the boundaries of a burndown segment, keyed by grant ID. */
+export interface EntitlementBurndownGrantBalances {
+    /** The balance of each active grant at the start of the segment. */
+    start: Record<string, string>;
+    /** The balance of each active grant at the end of the segment. */
+    end: Record<string, string>;
+}
 /** Cost basis with an explicit conversion rate supplied with the charge. */
 export interface CreateChargeCostBasisManual {
     /** Discriminator selecting the cost basis mode. */
@@ -873,6 +934,17 @@ export interface ProfileReference {
     /** The ID of the billing profile. */
     id: string;
 }
+/** Feature reference. */
+export interface FeatureReference {
+    id: string;
+}
+/** Usage taken from a single grant. */
+export interface EntitlementGrantUsage {
+    /** The ID of the grant. */
+    grantId: string;
+    /** The usage taken from the grant. */
+    usage: string;
+}
 /** Cost basis pinned to a specific cost basis resource of the custom currency. */
 export interface CreateChargeCostBasisPinned {
     /** Discriminator selecting the cost basis mode. */
@@ -908,6 +980,10 @@ export interface CreditGrantInvoiceReference {
         id: string;
     };
 }
+/** CurrencyCustom reference. */
+export interface CurrencyCustomReference {
+    id: string;
+}
 /** A cost basis pinned to a custom-currency pair for the subscription. */
 export interface SubscriptionCostBasisPin {
     /** The managed custom currency ID. */
@@ -917,10 +993,6 @@ export interface SubscriptionCostBasisPin {
     /** The pinned cost basis resource ID. */
     costBasisId: string;
 }
-/** Feature reference. */
-export interface FeatureReference {
-    id: string;
-}
 /**
  * Subscription reference represents a reference to the specific subscription item
  * this entity represents.
@@ -1102,24 +1174,6 @@ export interface AppStripeCreateCustomerPortalSessionResult {
      */
     url: string;
 }
-/**
- * Fiat conversion rate a custom-currency charge is invoiced at. Present once the
- * cost basis is resolved; dynamic cost bases are exposed only after the service
- * period has started.
- */
-export interface ChargeResolvedCostBasis {
-    /** The fiat currency the charge amount is converted into for invoicing. */
-    fiatCurrency: string;
-    /** Fiat amount per one unit of the custom currency. */
-    rate: string;
-    /**
-     * ID of the custom currency's cost basis resource the rate was taken from. Absent
-     * for manual cost bases.
-     */
-    costBasisId?: string;
-    /** When the rate was resolved. */
-    resolvedAt: Date;
-}
 /**
  * A period with defined start and end dates.
  *
@@ -1139,6 +1193,42 @@ export interface ClosedPeriod {
      */
     to: Date;
 }
+/** Request body for resetting the usage of a metered entitlement. */
+export interface ResetCustomerEntitlementUsageRequest {
+    /**
+     * The time the reset takes effect. Defaults to the current time and cannot be in
+     * the future. Truncated to the minute.
+     */
+    effectiveAt?: Date;
+    /**
+     * Whether the usage period anchor is kept. When false, the anchor moves to
+     * `effective_at`.
+     */
+    retainAnchor: boolean;
+    /**
+     * Whether overage carries over into the new usage period. Defaults to the
+     * entitlement's own setting.
+     */
+    preserveOverage?: boolean;
+}
+/**
+ * Fiat conversion rate a custom-currency charge is invoiced at. Present once the
+ * cost basis is resolved; dynamic cost bases are exposed only after the service
+ * period has started.
+ */
+export interface ChargeResolvedCostBasis {
+    /** The fiat currency the charge amount is converted into for invoicing. */
+    fiatCurrency: string;
+    /** Fiat amount per one unit of the custom currency. */
+    rate: string;
+    /**
+     * ID of the custom currency's cost basis resource the rate was taken from. Absent
+     * for manual cost bases.
+     */
+    costBasisId?: string;
+    /** When the rate was resolved. */
+    resolvedAt: Date;
+}
 /** A subscription add-on event. */
 export interface SubscriptionAddonTimelineSegment {
     /** An ISO-8601 timestamp representation of the cadence start of the resource. */
@@ -1398,22 +1488,6 @@ export interface NotImplemented extends BaseError {
 /** Not Available. */
 export interface NotAvailable extends BaseError {
 }
-/** Filters for the credit grant. */
-export interface CreateCreditGrantFilters {
-    /**
-     * Limit the credit grant to specific features. If no features are specified, the
-     * credit grant can be used for any feature.
-     */
-    features?: string[];
-}
-/** Filters for the credit grant. */
-export interface CreditGrantFilters {
-    /**
-     * Limit the credit grant to specific features. If no features are specified, the
-     * credit grant can be used for any feature.
-     */
-    features?: string[];
-}
 /**
  * A reference to the plan a subscription was created from, pinned to an exact
  * revision.
@@ -1776,6 +1850,43 @@ export interface CustomerStripeCreateCustomerPortalSessionRequest {
     /** Options for configuring the Stripe Customer Portal Session. */
     stripeOptions: AppStripeCreateCustomerPortalSessionOptions;
 }
+/** Entitlement access check result. */
+export interface EntitlementAccessCheckResult {
+    /**
+     * Whether the customer has access to the feature. Always true for `boolean` and
+     * `static` entitlements. Depends on balance for `metered` entitlements.
+     */
+    hasAccess: boolean;
+    /**
+     * Only available for static entitlements. Config is the JSON parsable
+     * configuration of the entitlement. Useful to describe per customer configuration.
+     */
+    config?: string;
+    /**
+     * The type of the entitlement.
+     *
+     * If not provided, the feature has no entitlement defined (has access is always
+     * false in this case)
+     */
+    type?: 'metered' | 'static' | 'boolean';
+}
+/**
+ * Recurring period input. The anchor is optional; the owning resource defines the
+ * default, typically its creation time.
+ */
+export interface RecurringPeriodInput {
+    /** The interval duration in ISO 8601 format. */
+    interval: string;
+    /** A date-time anchor to base the recurring period on. */
+    anchor?: Date;
+}
+/** Recurring period with an anchor and an interval. */
+export interface RecurringPeriod {
+    /** A date-time anchor to base the recurring period on. */
+    anchor: Date;
+    /** The interval duration in ISO 8601 format. */
+    interval: string;
+}
 /** The entitlement template of a metered entitlement. */
 export interface RateCardMeteredEntitlement {
     /** The type of the entitlement template. */
@@ -1826,12 +1937,32 @@ export interface SubscriptionEditStretchPhase {
     /** The ISO-8601 duration to extend the phase by. */
     extendBy: string;
 }
-/** Recurring period with an anchor and an interval. */
-export interface RecurringPeriod {
-    /** A date-time anchor to base the recurring period on. */
-    anchor: Date;
-    /** The interval duration in ISO 8601 format. */
-    interval: string;
+/** Filter options for getting a credit balance. */
+export interface GetCreditBalanceParamsFilter {
+    /**
+     * Filter credit balance by currency code. When historical custom currencies reuse
+     * a code, each managed currency is returned as a separate balance row.
+     */
+    currency?: StringFieldFilterExact;
+    /**
+     * Filter credit balance by feature key. Omit to return the total portfolio value.
+     * Use `exists=false` to return only unrestricted balance.
+     */
+    featureKey?: StringFieldFilter;
+}
+/** Filter options for listing plans. */
+export interface ListPlansParamsFilter {
+    key?: StringFieldFilter;
+    name?: StringFieldFilter;
+    status?: StringFieldFilterExact;
+    currency?: StringFieldFilterExact;
+}
+/** A plan key and an optional version constraint for matching credit grants. */
+export interface CreateCreditGrantPlanFilter {
+    /** The plan key in the customer's namespace. */
+    key: string;
+    /** Omission matches all versions, including future versions. */
+    version?: CreateVersionFilter;
 }
 /**
  * Request body for updating the external payment settlement status of a credit
@@ -1841,6 +1972,13 @@ export interface UpdateCreditGrantExternalSettlementRequest {
     /** The new payment settlement status. */
     status: 'pending' | 'authorized' | 'settled';
 }
+/** A plan key and an optional version constraint for matching credit grants. */
+export interface CreditGrantPlanFilter {
+    /** The plan key in the customer's namespace. */
+    key: string;
+    /** Omission matches all versions, including future versions. */
+    version?: VersionFilter;
+}
 /** Filter options for listing credit grants. */
 export interface ListCreditGrantsParamsFilter {
     /** Filter credit grants by status. */
@@ -1865,26 +2003,6 @@ export interface ValidationIssue {
     /** Component that reported the validation issue, if applicable. */
     component?: string;
 }
-/** Filter options for getting a credit balance. */
-export interface GetCreditBalanceParamsFilter {
-    /**
-     * Filter credit balance by currency code. When historical custom currencies reuse
-     * a code, each managed currency is returned as a separate balance row.
-     */
-    currency?: StringFieldFilterExact;
-    /**
-     * Filter credit balance by feature key. Omit to return the total portfolio value.
-     * Use `exists=false` to return only unrestricted balance.
-     */
-    featureKey?: StringFieldFilter;
-}
-/** Filter options for listing plans. */
-export interface ListPlansParamsFilter {
-    key?: StringFieldFilter;
-    name?: StringFieldFilter;
-    status?: StringFieldFilterExact;
-    currency?: StringFieldFilterExact;
-}
 /** Request body for voiding a credit grant. */
 export interface VoidCreditGrantRequest {
     /**
@@ -2197,6 +2315,120 @@ export interface EntitlementAccessQueryError {
     /** The customer identifier from the request that produced this error. */
     customer?: string;
 }
+/**
+ * A notification channel delivers notification events, such as entitlement balance
+ * threshold crossings, to an external system. Today the only supported channel
+ * type is a webhook delivered via Svix.
+ */
+export interface NotificationChannel {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: 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 type of the channel. Immutable after creation. */
+    type: 'webhook';
+    /**
+     * Whether the channel is disabled. Disabled channels do not receive notification
+     * events.
+     */
+    disabled: boolean;
+    /** The URL that webhook notification events are delivered to. */
+    url: string;
+    /**
+     * Custom HTTP headers to include on every webhook delivery request, keyed by
+     * header name.
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * Secret used to sign outgoing webhook payloads so recipients can verify their
+     * authenticity. If omitted on create, a secret is generated automatically by the
+     * delivery provider. This is a sensitive credential returned in responses (unlike
+     * most secrets) specifically so clients can retrieve a server-generated value and
+     * verify webhook signatures; handle it with the same care as any other credential.
+     */
+    signingSecret?: string;
+}
+/** NotificationChannel create request. */
+export interface CreateNotificationChannelRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of the channel. Immutable after creation. */
+    type: 'webhook';
+    /**
+     * Whether the channel is disabled. Disabled channels do not receive notification
+     * events.
+     */
+    disabled: boolean;
+    /** The URL that webhook notification events are delivered to. */
+    url: string;
+    /**
+     * Custom HTTP headers to include on every webhook delivery request, keyed by
+     * header name.
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * Secret used to sign outgoing webhook payloads so recipients can verify their
+     * authenticity. If omitted on create, a secret is generated automatically by the
+     * delivery provider. This is a sensitive credential returned in responses (unlike
+     * most secrets) specifically so clients can retrieve a server-generated value and
+     * verify webhook signatures; handle it with the same care as any other credential.
+     */
+    signingSecret?: string;
+}
+/**
+ * Request body for updating a notification channel. Updates replace the channel's
+ * mutable state rather than merging it: `type`, `name`, and `url` must always be
+ * provided, and omitting `disabled`, `labels`, or `custom_headers` resets them to
+ * their defaults (enabled, no labels, no custom headers). `signing_secret` is the
+ * one exception: omitting it keeps the channel's current signing secret instead of
+ * clearing the credential.
+ */
+export interface UpdateBillingNotificationChannelRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /** The type of the channel. Immutable after creation. */
+    type: 'webhook';
+    /** The URL that webhook notification events are delivered to. */
+    url: string;
+    labels?: Labels;
+    /**
+     * Whether the channel is disabled. Disabled channels do not receive notification
+     * events.
+     */
+    disabled: boolean;
+    /**
+     * Custom HTTP headers to include on every webhook delivery request, keyed by
+     * header name.
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * Secret used to sign outgoing webhook payloads so recipients can verify their
+     * authenticity. If omitted on create, a secret is generated automatically by the
+     * delivery provider. This is a sensitive credential returned in responses (unlike
+     * most secrets) specifically so clients can retrieve a server-generated value and
+     * verify webhook signatures; handle it with the same care as any other credential.
+     */
+    signingSecret?: string;
+}
 /** App customer data. */
 export interface AppCustomerData {
     /**
@@ -2254,26 +2486,6 @@ export interface CreditAdjustment {
     description?: string;
     labels?: Labels;
 }
-/** The credit balance by currency. */
-export interface CreditBalance {
-    currency: BillingCurrencyCode;
-    /** Immutable managed currency identifier. Present only for custom currencies. */
-    customCurrencyId?: string;
-    /**
-     * 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;
-    /**
-     * Credits that have been granted but are not yet written to the ledger, or are
-     * written to the ledger with a future booked time.
-     */
-    pending: string;
-}
 /** CreditAdjustment create request. */
 export interface CreateCreditAdjustmentRequest {
     /**
@@ -2310,48 +2522,6 @@ export interface ListCreditTransactionsParamsFilter {
      */
     featureKey?: StringFieldFilter;
 }
-/**
- * A credit transaction represents a single credit movement on the customer's
- * balance.
- *
- * Credit transactions are immutable.
- */
-export interface CreditTransaction {
-    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;
-    /** The date and time the transaction was booked. */
-    bookedAt: Date;
-    /** The type of credit transaction. */
-    type: 'funded' | 'consumed' | 'expired' | 'voided';
-    /** Currency of the balance affected by the transaction. */
-    currency: BillingCurrencyCode;
-    /** Immutable managed currency identifier. Present only for custom currencies. */
-    customCurrencyId?: string;
-    /**
-     * Signed amount of the credit movement. Positive values add balance, negative
-     * values reduce balance.
-     */
-    amount: string;
-    /** The available balance before and after the transaction. */
-    availableBalance: {
-        before: string;
-        after: string;
-    };
-}
 /** Monetary amount in a fiat or custom currency. */
 export interface CurrencyAmount {
     /** The amount as an arbitrary-precision decimal string. */
@@ -2359,11 +2529,34 @@ export interface CurrencyAmount {
     /** The fiat or custom currency code of the amount. */
     currency: BillingCurrencyCode;
 }
-/** Entitlement access result. */
-export interface EntitlementAccessResult {
+/** Entitlement value result. */
+export interface EntitlementValueResult {
     /** The type of the entitlement. */
     type: 'metered' | 'static' | 'boolean';
-    /** The feature key of the entitlement. */
+    /** The feature key being evaluated. */
+    featureKey: string;
+    /**
+     * Whether the customer has access to the feature. Always true for `boolean` and
+     * `static` entitlements. Depends on balance for `metered` entitlements.
+     */
+    hasAccess: boolean;
+    /**
+     * Only available for static entitlements. Config is the JSON parsable
+     * configuration of the entitlement. Useful to describe per customer configuration.
+     */
+    config?: string;
+    /**
+     * Only available for metered entitlements. The balance details of the entitlement
+     * at the evaluation time. Requires the `value` expand.
+     */
+    value?: EntitlementAccessValue;
+}
+/**
+ * Entitlement value looked up by feature key. A missing entitlement has no type
+ * and does not grant access.
+ */
+export interface EntitlementFeatureValueResult {
+    /** The feature key being evaluated. */
     featureKey: string;
     /**
      * Whether the customer has access to the feature. Always true for `boolean` and
@@ -2376,10 +2569,17 @@ export interface EntitlementAccessResult {
      */
     config?: string;
     /**
-     * Only available for metered entitlements. The current balance details of the
-     * entitlement. Requires the `value` expand.
+     * Only available for metered entitlements. The balance details of the entitlement
+     * at the evaluation time. Requires the `value` expand.
      */
     value?: EntitlementAccessValue;
+    /**
+     * The type of the entitlement.
+     *
+     * If not provided, the feature has no entitlement defined (has access is always
+     * false in this case)
+     */
+    type?: 'metered' | 'static' | 'boolean';
 }
 /**
  * A price tier used in graduated and volume pricing.
@@ -2537,6 +2737,33 @@ export interface ListCustomersParamsFilter {
     planKey?: StringFieldFilter;
     billingProfileId?: UlidFieldFilter;
 }
+/** Filter options for listing customer entitlements. */
+export interface ListCustomerEntitlementsParamsFilter {
+    /** Filter entitlements by feature ID. */
+    featureId?: UlidFieldFilter;
+    /** Filter entitlements by feature key. */
+    featureKey?: StringFieldFilterExact;
+    /** Filter entitlements by type (`metered`, `static` or `boolean`). */
+    type?: StringFieldFilterExact;
+}
+/** Filter options for listing entitlements. */
+export interface ListEntitlementsParamsFilter {
+    /** Filter entitlements by feature ID. */
+    featureId?: UlidFieldFilter;
+    /** Filter entitlements by feature key. */
+    featureKey?: StringFieldFilterExact;
+    /** Filter entitlements by type (`metered`, `static` or `boolean`). */
+    type?: StringFieldFilterExact;
+    /** Filter entitlements by customer ID. */
+    customerId?: UlidFieldFilter;
+}
+/** Filter options for listing grants. */
+export interface ListGrantsParamsFilter {
+    /** Filter grants by the ID of the customer that owns the entitlement. */
+    customerId?: UlidFieldFilter;
+    /** Filter grants by the ID of the entitlement's feature. */
+    featureId?: UlidFieldFilter;
+}
 /** Filter options for listing subscriptions. */
 export interface ListSubscriptionsParamsFilter {
     id?: UlidFieldFilter;
@@ -2581,33 +2808,44 @@ export interface ListPlanAddonsParamsFilter {
     planCurrency?: StringFieldFilter;
 }
 /**
- * Tax configuration for a credit grant.
+ * Tax configuration for a billable resource.
  *
- * Tax configuration should be provided to ensure correct revenue recognition,
- * including for externally funded grants.
+ * Applies a tax code and tax behavior to the resulting invoice line items. When
+ * not set, the applicable default is used: the billing profile default tax
+ * configuration, then the organization default tax code.
  */
-export interface CreateCreditGrantTaxConfig {
-    /** Tax behavior applied to the invoice line item. */
+export interface CreateTaxCodeConfig {
+    /**
+     * Tax behavior.
+     *
+     * This enum is used to specify whether tax is included in the price or excluded
+     * from the price. If not specified, the billing profile is used to determine the
+     * tax behavior. If not specified in the billing profile, the provider's default
+     * behavior is used.
+     */
     behavior?: 'inclusive' | 'exclusive';
     /** Tax code applied to the invoice line item. */
-    taxCode?: CreateResourceReference;
+    code?: CreateResourceReference;
 }
 /**
- * Tax configuration for a credit grant.
+ * Tax configuration for a billable resource.
  *
- * Tax configuration should be provided to ensure correct revenue recognition,
- * including for externally funded grants.
+ * Applies a tax code and tax behavior to the resulting invoice line items. When
+ * not set, the applicable default is used: the billing profile default tax
+ * configuration, then the organization default tax code.
  */
-export interface CreditGrantTaxConfig {
-    /** Tax behavior applied to the invoice line item. */
+export interface TaxCodeConfig {
+    /**
+     * Tax behavior.
+     *
+     * This enum is used to specify whether tax is included in the price or excluded
+     * from the price. If not specified, the billing profile is used to determine the
+     * tax behavior. If not specified in the billing profile, the provider's default
+     * behavior is used.
+     */
     behavior?: 'inclusive' | 'exclusive';
     /** Tax code applied to the invoice line item. */
-    taxCode?: TaxCodeReference;
-}
-/** The tax config of the rate card. */
-export interface RateCardTaxConfig {
-    behavior?: 'inclusive' | 'exclusive';
-    code: TaxCodeReference;
+    code?: TaxCodeReference;
 }
 /** Set of provider specific tax configs. */
 export interface TaxConfig {
@@ -2656,6 +2894,68 @@ export interface UpdateOrganizationDefaultTaxCodesRequest {
     /** Default tax code for credit grants. */
     creditGrantTaxCode?: TaxCodeReference;
 }
+/** The credit balance by currency. */
+export interface CreditBalance {
+    currency: BillingCurrencyCode;
+    /** Managed currency reference. Present only for custom currencies. */
+    customCurrency?: CurrencyCustomReference;
+    /**
+     * 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;
+    /**
+     * Credits that have been granted but are not yet written to the ledger, or are
+     * written to the ledger with a future booked time.
+     */
+    pending: string;
+}
+/**
+ * A credit transaction represents a single credit movement on the customer's
+ * balance.
+ *
+ * Credit transactions are immutable.
+ */
+export interface CreditTransaction {
+    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;
+    /** The date and time the transaction was booked. */
+    bookedAt: Date;
+    /** The type of credit transaction. */
+    type: 'funded' | 'consumed' | 'expired' | 'voided';
+    /** Currency of the balance affected by the transaction. */
+    currency: BillingCurrencyCode;
+    /** Managed currency reference. Present only for custom currencies. */
+    customCurrency?: CurrencyCustomReference;
+    /**
+     * Signed amount of the credit movement. Positive values add balance, negative
+     * values reduce balance.
+     */
+    amount: string;
+    /** The available balance before and after the transaction. */
+    availableBalance: {
+        before: string;
+        after: string;
+    };
+}
 /**
  * BillingInvoiceWorkflowAppsReferences represents the references (id) to the apps
  * used by a billing profile
@@ -2741,10 +3041,25 @@ export interface CreatePlanAddonRequest {
      */
     maxQuantity?: number;
 }
-/** The tax config of the rate card. */
-export interface UpdateRateCardTaxConfig {
+/**
+ * Tax configuration for a billable resource.
+ *
+ * Applies a tax code and tax behavior to the resulting invoice line items. When
+ * not set, the applicable default is used: the billing profile default tax
+ * configuration, then the organization default tax code.
+ */
+export interface UpdateTaxCodeConfig {
+    /**
+     * Tax behavior.
+     *
+     * This enum is used to specify whether tax is included in the price or excluded
+     * from the price. If not specified, the billing profile is used to determine the
+     * tax behavior. If not specified in the billing profile, the provider's default
+     * behavior is used.
+     */
     behavior?: 'inclusive' | 'exclusive';
-    code: UpdateResourceReference;
+    /** Tax code applied to the invoice line item. */
+    code?: UpdateResourceReference;
 }
 /** Filter options for listing ingested events. */
 export interface ListEventsParamsFilter {
@@ -2828,6 +3143,15 @@ export interface ListChargesParamsFilter {
     /** Filter charges by the ID of their customer. */
     customerId?: UlidFieldFilter;
 }
+/** Filter options for listing notification channels. */
+export interface ListNotificationChannelsParamsFilter {
+    id?: UlidFieldFilter;
+    name?: StringFieldFilter;
+    type?: StringFieldFilterExact;
+    disabled?: BooleanFieldFilter;
+    createdAt?: DateTimeFieldFilter;
+    updatedAt?: DateTimeFieldFilter;
+}
 /** Resource filters. */
 export interface ResourceFilters {
     name?: StringFieldFilter;
@@ -2839,9 +3163,7 @@ export interface ResourceFilters {
 }
 /** Field filters with all supported types. */
 export interface FieldFilters {
-    boolean?: boolean | {
-        eq: boolean;
-    };
+    boolean?: BooleanFieldFilter;
     numeric?: number | {
         eq?: number;
         neq?: number;
@@ -2879,6 +3201,33 @@ export interface MeterQueryResult {
     /** The usage data. If no data is available, an empty array is returned. */
     data: MeterQueryRow[];
 }
+/** Usage and balance of a single history window. */
+export interface EntitlementHistoryWindow {
+    /** The period the window covers. */
+    period: ClosedPeriod;
+    /** The usage recorded in the window. */
+    usage: string;
+    /** The entitlement balance at the start of the window. */
+    balanceAtStart: string;
+}
+/** A period in which grants were consumed in a fixed order. */
+export interface EntitlementBurndownSegment {
+    /** The period the segment covers. */
+    period: ClosedPeriod;
+    /** The usage recorded in the segment. */
+    usage: string;
+    /** The usage in the segment not covered by any grant. */
+    overage: string;
+    /** The entitlement balance at the start and at the end of the segment. */
+    balance: EntitlementBurndownBalance;
+    /**
+     * The balance of each active grant at the start and at the end of the segment,
+     * keyed by grant ID.
+     */
+    grantBalances: EntitlementBurndownGrantBalances;
+    /** The grants consumed in the segment and the usage taken from each. */
+    grantUsages: EntitlementGrantUsage[];
+}
 /** A detailed line produced by a flat fee charge's realization run. */
 export interface ChargeRealizationDetailedLineFlatFee {
     id: string;
@@ -3117,52 +3466,313 @@ export interface InvoiceCustomer {
      * resource itself, the key is optional here because the invoice snapshot may
      * predate or omit it.
      */
-    key?: string;
-}
-/** A collection of addresses for the party. */
-export interface UpdateBillingPartyAddresses {
-    /** Billing address. */
-    billingAddress: UpdateAddress;
-}
-/** Snapshot of the customer's information at the time the invoice was issued. */
-export interface UpdateInvoiceCustomer {
+    key?: string;
+}
+/** A collection of addresses for the party. */
+export interface UpdateBillingPartyAddresses {
+    /** Billing address. */
+    billingAddress: UpdateAddress;
+}
+/** Snapshot of the customer's information at the time the invoice was issued. */
+export interface UpdateInvoiceCustomer {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /** Mapping to attribute metered usage to the customer by the event subject. */
+    usageAttribution?: UpdateCustomerUsageAttribution;
+    /** The billing address of the customer. Used for tax and invoicing. */
+    billingAddress?: UpdateAddress;
+    id: string;
+    /**
+     * Optional external resource key for the customer.
+     *
+     * Omitted when the customer was created without a key. Unlike on the customer
+     * resource itself, the key is optional here because the invoice snapshot may
+     * predate or omit it.
+     */
+    key?: string;
+}
+/** Checkout Session consent collection configuration. */
+export interface AppStripeCreateCheckoutSessionConsentCollection {
+    /** Controls the visibility of payment method reuse agreement. */
+    paymentMethodReuseAgreement?: AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement;
+    /**
+     * Enables collection of promotional communication consent.
+     *
+     * Only available to US merchants. When set to "auto", Checkout determines whether
+     * to show the option based on the customer's locale.
+     */
+    promotions?: 'auto' | 'none';
+    /**
+     * Requires customers to accept terms of service before payment.
+     *
+     * Requires a valid terms of service URL in your Stripe Dashboard settings.
+     */
+    termsOfService?: 'none' | 'required';
+}
+/** A grant to issue for a metered entitlement. */
+export interface EntitlementGrantCreateRequest {
+    /** The amount to grant, in the feature's unit. Must be positive. */
+    amount: string;
+    /**
+     * The priority of the grant. Lower values have higher priority. Grants are
+     * consumed in priority order, then by closest expiration, then by earliest
+     * creation.
+     */
+    priority?: number;
+    /**
+     * The time the grant becomes effective and the anchor for recurring grants. The
+     * value is truncated to the start of the minute.
+     */
+    effectiveAt: Date;
+    /**
+     * The duration after which the grant expires, counted from `effective_at`. Only
+     * single-unit durations are accepted, such as `PT12H`, `P7D`, `P2W`, `P3M`, or
+     * `P1Y`. If omitted, the grant never expires.
+     */
+    expiresAfter?: string;
+    /**
+     * The maximum balance carried over at reset. The balance after a reset is
+     * `MIN(max_rollover_amount, MAX(balance_before_reset, min_rollover_amount))`.
+     * Defaults to `amount`.
+     */
+    maxRolloverAmount?: string;
+    /**
+     * The minimum balance carried over at reset. The balance after a reset is
+     * `MIN(max_rollover_amount, MAX(balance_before_reset, min_rollover_amount))`.
+     * Defaults to `0`.
+     */
+    minRolloverAmount?: string;
+    labels?: Labels;
+    /**
+     * The recurrence of the grant. When set, the amount is issued again every
+     * interval. The anchor defaults to `effective_at`.
+     */
+    recurrence?: RecurringPeriodInput;
+}
+/** Static entitlement create request. */
+export interface CreateEntitlementStaticRequest {
+    /** The type of the entitlement. */
+    type: 'static';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    labels?: Labels;
+    /**
+     * The entitlement configuration as a JSON value. Returned when checking
+     * entitlement access.
+     */
+    config: unknown;
+    /**
+     * The usage period of the entitlement. The anchor defaults to the entitlement
+     * creation time.
+     */
+    usagePeriod?: RecurringPeriodInput;
+}
+/** Boolean entitlement create request. */
+export interface CreateEntitlementBooleanRequest {
+    /** The type of the entitlement. */
+    type: 'boolean';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    labels?: Labels;
+    /**
+     * The usage period of the entitlement. The anchor defaults to the entitlement
+     * creation time.
+     */
+    usagePeriod?: RecurringPeriodInput;
+}
+/**
+ * A metered entitlement grants a usage allowance for a feature. Access is
+ * determined by the balance: the allowance provided by grants is burnt down by
+ * usage.
+ */
+export interface EntitlementMetered {
+    id: string;
+    /** The type of the entitlement. */
+    type: 'metered';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    /** The customer the entitlement belongs to. */
+    customer: CustomerReference;
+    labels?: Labels;
+    /** The time from which the entitlement is active. */
+    activeFrom: Date;
+    /**
+     * The time until which the entitlement is active. If not set, the entitlement is
+     * active until deleted.
+     */
+    activeTo?: Date;
+    /** The time the entitlement was created. */
+    createdAt: Date;
+    /** The time the entitlement was last updated. */
+    updatedAt: Date;
+    /** The time the entitlement was deleted. */
+    deletedAt?: Date;
+    /**
+     * The usage period of the entitlement. The balance resets at the start of every
+     * period.
+     */
+    usagePeriod: RecurringPeriod;
+    /** The current usage period of the entitlement. */
+    currentUsagePeriod: ClosedPeriod;
+    /**
+     * If true, the customer keeps access to the feature after the balance is
+     * exhausted.
+     */
+    isSoftLimit: boolean;
+    /** Usage granted automatically after each reset. Cannot be combined with `grants`. */
+    issue?: EntitlementIssueAfterReset;
+    /** The amount granted automatically after each reset. */
+    issueAfterReset?: string;
+    /** The priority of the grant created after each reset. */
+    issueAfterResetPriority: number;
+    /** If true, the overage is preserved at reset. If false, the usage is reset to 0. */
+    preserveOverageAtReset: boolean;
+    /** The time from which usage is measured. */
+    measureUsageFrom: Date;
+    /** The time of the last reset. */
+    lastReset: Date;
+}
+/** A static entitlement grants access to a feature together with a configuration. */
+export interface EntitlementStatic {
+    id: string;
+    /** The type of the entitlement. */
+    type: 'static';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    /** The customer the entitlement belongs to. */
+    customer: CustomerReference;
+    labels?: Labels;
+    /** The usage period of the entitlement. */
+    usagePeriod?: RecurringPeriod;
+    /** The current usage period of the entitlement. */
+    currentUsagePeriod?: ClosedPeriod;
+    /** The time from which the entitlement is active. */
+    activeFrom: Date;
+    /**
+     * The time until which the entitlement is active. If not set, the entitlement is
+     * active until deleted.
+     */
+    activeTo?: Date;
+    /** The time the entitlement was created. */
+    createdAt: Date;
+    /** The time the entitlement was last updated. */
+    updatedAt: Date;
+    /** The time the entitlement was deleted. */
+    deletedAt?: Date;
+    /**
+     * The entitlement configuration as a JSON value. Returned when checking
+     * entitlement access.
+     */
+    config: unknown;
+}
+/** A boolean entitlement grants access to a feature. */
+export interface EntitlementBoolean {
+    id: string;
+    /** The type of the entitlement. */
+    type: 'boolean';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    /** The customer the entitlement belongs to. */
+    customer: CustomerReference;
+    labels?: Labels;
+    /** The usage period of the entitlement. */
+    usagePeriod?: RecurringPeriod;
+    /** The current usage period of the entitlement. */
+    currentUsagePeriod?: ClosedPeriod;
+    /** The time from which the entitlement is active. */
+    activeFrom: Date;
+    /**
+     * The time until which the entitlement is active. If not set, the entitlement is
+     * active until deleted.
+     */
+    activeTo?: Date;
+    /** The time the entitlement was created. */
+    createdAt: Date;
+    /** The time the entitlement was last updated. */
+    updatedAt: Date;
+    /** The time the entitlement was deleted. */
+    deletedAt?: Date;
+}
+/**
+ * A grant issued for a metered entitlement. Each grant adds its amount to the
+ * entitlement's balance from its effective time until it expires, and usage is
+ * deducted from the grants in priority order.
+ *
+ * Grants are immutable, so the balance is deterministic regardless of when it is
+ * queried. Deleting a grant ends it at the time of the deletion.
+ */
+export interface EntitlementGrant {
+    id: string;
+    /** The ID of the entitlement the grant belongs to. */
+    entitlementId: string;
+    /** The ID of the customer the grant belongs to. */
+    customerId?: string;
+    /** The granted amount, in the feature's unit. */
+    amount: string;
+    /**
+     * The priority of the grant. Lower values are consumed first: a grant with
+     * priority 1 is consumed before one with priority 2. Among equal priorities, the
+     * grant closest to expiration is consumed first, then the earliest created.
+     */
+    priority: number;
+    /** The time the grant takes effect. */
+    effectiveAt: Date;
+    /**
+     * The duration after which the grant expires, counted from `effective_at`. Always
+     * a single-unit duration (for example `PT12H`, `P7D`, `P2W`, `P3M`, `P1Y`). Absent
+     * when the grant never expires.
+     */
+    expiresAfter?: string;
     /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
+     * The time the grant expires, calculated from `effective_at` and `expires_after`.
+     * The grant is no longer in effect from this time. Absent when the grant never
+     * expires.
      */
-    name: string;
-    /** Mapping to attribute metered usage to the customer by the event subject. */
-    usageAttribution?: UpdateCustomerUsageAttribution;
-    /** The billing address of the customer. Used for tax and invoicing. */
-    billingAddress?: UpdateAddress;
-    id: string;
+    expiresAt?: Date;
     /**
-     * Optional external resource key for the customer.
-     *
-     * Omitted when the customer was created without a key. Unlike on the customer
-     * resource itself, the key is optional here because the invoice snapshot may
-     * predate or omit it.
+     * The maximum balance the grant carries over at reset. The balance after a reset
+     * is `MIN(max_rollover_amount, MAX(balance_before_reset, min_rollover_amount))`.
      */
-    key?: string;
-}
-/** Checkout Session consent collection configuration. */
-export interface AppStripeCreateCheckoutSessionConsentCollection {
-    /** Controls the visibility of payment method reuse agreement. */
-    paymentMethodReuseAgreement?: AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement;
+    maxRolloverAmount: string;
     /**
-     * Enables collection of promotional communication consent.
-     *
-     * Only available to US merchants. When set to "auto", Checkout determines whether
-     * to show the option based on the customer's locale.
+     * The minimum balance the grant carries over at reset. The balance after a reset
+     * is `MIN(max_rollover_amount, MAX(balance_before_reset, min_rollover_amount))`.
      */
-    promotions?: 'auto' | 'none';
+    minRolloverAmount: string;
     /**
-     * Requires customers to accept terms of service before payment.
-     *
-     * Requires a valid terms of service URL in your Stripe Dashboard settings.
+     * The recurrence of the grant. When set, the grant amount is re-issued every
+     * interval from the anchor, which defaults to `effective_at`. Absent for
+     * non-recurring grants.
      */
-    termsOfService?: 'none' | 'required';
+    recurrence?: RecurringPeriod;
+    /** The next time the grant recurs. Absent for non-recurring grants. */
+    nextRecurrence?: Date;
+    /**
+     * The time the grant was voided. A voided grant is no longer in effect from this
+     * time.
+     */
+    voidedAt?: Date;
+    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;
+}
+/**
+ * BillingWorkflowCollectionAlignmentAnchored specifies the alignment for
+ * collecting the pending line items into an invoice.
+ */
+export interface WorkflowCollectionAlignmentAnchored {
+    /** The type of alignment. */
+    type: 'anchored';
+    /** The recurring period for the alignment. */
+    recurringPeriod: RecurringPeriod;
 }
 /**
  * Add a new phase to the subscription. The phase is created without items; use
@@ -3174,15 +3784,33 @@ export interface SubscriptionEditAddPhase {
     /** The phase to add. */
     phase: SubscriptionPhaseCreate;
 }
-/**
- * BillingWorkflowCollectionAlignmentAnchored specifies the alignment for
- * collecting the pending line items into an invoice.
- */
-export interface WorkflowCollectionAlignmentAnchored {
-    /** The type of alignment. */
-    type: 'anchored';
-    /** The recurring period for the alignment. */
-    recurringPeriod: RecurringPeriod;
+/** Filters for the credit grant. */
+export interface CreateCreditGrantFilters {
+    /**
+     * Limit the credit grant to specific features. If no features are specified, the
+     * credit grant can be used for any feature.
+     */
+    features?: string[];
+    /**
+     * Limit credits to charges from these plans. Entries are alternatives; when
+     * features are also specified, both dimensions must match. Omission or an empty
+     * list leaves plans unrestricted.
+     */
+    plans?: CreateCreditGrantPlanFilter[];
+}
+/** Filters for the credit grant. */
+export interface CreditGrantFilters {
+    /**
+     * Limit the credit grant to specific features. If no features are specified, the
+     * credit grant can be used for any feature.
+     */
+    features?: string[];
+    /**
+     * Limit credits to charges from these plans. Entries are alternatives; when
+     * features are also specified, both dimensions must match. Omission or an empty
+     * list leaves plans unrestricted.
+     */
+    plans?: CreditGrantPlanFilter[];
 }
 /** Subscription fields without phases or the current billing period. */
 export interface SubscriptionBase {
@@ -3463,6 +4091,11 @@ export interface EntitlementFeatureAccess {
      */
     reason?: EntitlementFeatureAccessReason;
 }
+/** Page paginated response. */
+export interface NotificationChannelPagePaginatedResponse {
+    data: NotificationChannel[];
+    meta: PaginatedMeta;
+}
 /** Billing customer data. */
 export interface CustomerData {
     /**
@@ -3485,18 +4118,6 @@ export interface UpsertCustomerBillingDataRequest {
     /** App customer data. */
     appData?: AppCustomerData;
 }
-/** The balances of the credits of a customer. */
-export interface CreditBalances {
-    /** The timestamp of the balance retrieval. */
-    retrievedAt: Date;
-    /** The balances by currencies. */
-    balances: CreditBalance[];
-}
-/** Cursor paginated response. */
-export interface CreditTransactionPaginatedResponse {
-    data: CreditTransaction[];
-    meta: CursorMeta;
-}
 /**
  * Flat fee intent fields from the system lifecycle controller shadowed by a manual
  * override.
@@ -3540,7 +4161,7 @@ export interface ChargeFlatFeeSystemIntent {
 /** List customer entitlement access response data. */
 export interface ListCustomerEntitlementAccessResponseData {
     /** The list of entitlement access results. */
-    data: EntitlementAccessResult[];
+    data: EntitlementValueResult[];
 }
 /**
  * Graduated tiered price.
@@ -3762,6 +4383,18 @@ export interface WorkflowTaxSettings {
      */
     defaultTaxConfig?: TaxConfig;
 }
+/** The balances of the credits of a customer. */
+export interface CreditBalances {
+    /** The timestamp of the balance retrieval. */
+    retrievedAt: Date;
+    /** The balances by currencies. */
+    balances: CreditBalance[];
+}
+/** Cursor paginated response. */
+export interface CreditTransactionPaginatedResponse {
+    data: CreditTransaction[];
+    meta: CursorMeta;
+}
 /** Page paginated response. */
 export interface PlanAddonPagePaginatedResponse {
     data: PlanAddon[];
@@ -3772,6 +4405,20 @@ export interface IngestedEventPaginatedResponse {
     data: IngestedEvent[];
     meta: CursorMeta;
 }
+/** Balance and usage history of a metered entitlement. */
+export interface EntitlementHistory {
+    /**
+     * Usage in half-open windows of the requested size, aligned to the requested time
+     * zone. Empty windows are included; windows before usage measurement began are
+     * omitted.
+     */
+    windowedHistory: EntitlementHistoryWindow[];
+    /**
+     * Periods in which grants were consumed in a fixed order. A new segment starts
+     * whenever grant priorities change or a usage period starts.
+     */
+    burndownHistory: EntitlementBurndownSegment[];
+}
 /** The list of parameters that failed validation. */
 export type InvalidParameters = InvalidParameter[];
 /** A meter query request. */
@@ -3950,6 +4597,44 @@ export interface AppStripeCreateCheckoutSessionRequestOptions {
     /** Configuration for collecting tax IDs during checkout. */
     taxIdCollection?: AppStripeCreateCheckoutSessionTaxIdCollection;
 }
+/** Metered entitlement create request. */
+export interface CreateEntitlementMeteredRequest {
+    /** The type of the entitlement. */
+    type: 'metered';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    labels?: Labels;
+    /**
+     * If true, the customer keeps access to the feature after the balance is
+     * exhausted.
+     */
+    isSoftLimit: boolean;
+    /** Usage granted automatically after each reset. Cannot be combined with `grants`. */
+    issue?: EntitlementIssueAfterReset;
+    /** The amount granted automatically after each reset. */
+    issueAfterReset?: string;
+    /** The priority of the grant created after each reset. */
+    issueAfterResetPriority: number;
+    /** If true, the overage is preserved at reset. If false, the usage is reset to 0. */
+    preserveOverageAtReset: boolean;
+    /**
+     * The usage period of the entitlement. The balance resets at the start of every
+     * period. The anchor defaults to the entitlement creation time.
+     */
+    usagePeriod: RecurringPeriodInput;
+    /**
+     * The time from which usage is measured. Defaults to the entitlement creation
+     * time.
+     */
+    measureUsageFrom?: EntitlementMeasureUsageFrom;
+    /** Grants created together with the entitlement. Cannot be combined with `issue`. */
+    grants?: EntitlementGrantCreateRequest[];
+}
+/** Page paginated response. */
+export interface EntitlementGrantPagePaginatedResponse {
+    data: EntitlementGrant[];
+    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. */
@@ -4428,7 +5113,7 @@ export interface CreateCreditGrantRequest {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreateCreditGrantTaxConfig;
+    taxConfig?: CreateTaxCodeConfig;
     filters?: CreateCreditGrantFilters;
     /** Draw-down priority of the grant. Lower values have higher priority. */
     priority: number;
@@ -4501,7 +5186,7 @@ export interface CreditGrant {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreditGrantTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** Available when `funding_method` is `invoice`. */
     invoice?: CreditGrantInvoiceReference;
     filters?: CreditGrantFilters;
@@ -4616,6 +5301,11 @@ export interface CustomerStripeCreateCheckoutSessionRequest {
      */
     stripeOptions: AppStripeCreateCheckoutSessionRequestOptions;
 }
+/** Page paginated response. */
+export interface EntitlementPagePaginatedResponse {
+    data: Entitlement[];
+    meta: PaginatedMeta;
+}
 /**
  * Workflow collection specifies how to collect the pending line items for an
  * invoice.
@@ -4775,7 +5465,7 @@ export interface RateCard {
     /** The discounts of the rate card. */
     discounts?: RateCardDiscounts;
     /** The tax config of the rate card. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /**
      * The entitlement template granted to subscribers of a plan or addon containing
      * this rate card. Requires `feature` to be set.
@@ -4787,7 +5477,7 @@ export interface InvoiceLineRateCard {
     /** The price definition used to calculate charges for this line. */
     price: Price;
     /** Tax configuration snapshot for this line. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** The feature key associated with this line's rate card. */
     featureKey?: string;
     /** Discount configuration from the rate card. */
@@ -4927,7 +5617,7 @@ export interface UpdateInvoiceLineRateCard {
     /** The price definition used to calculate charges for this line. */
     price: UpdatePrice;
     /** Tax configuration snapshot for this line. */
-    taxConfig?: UpdateRateCardTaxConfig;
+    taxConfig?: UpdateTaxCodeConfig;
     /** The feature key associated with this line's rate card. */
     featureKey?: string;
     /** Discount configuration from the rate card. */
@@ -6309,6 +6999,11 @@ export type MeterAggregation = 'sum' | 'count' | 'unique_count' | 'avg' | 'min'
  * format.
  */
 export type MeterQueryGranularity = 'PT1M' | 'PT1H' | 'P1D' | 'P1M';
+/**
+ * The meter query granularities the usage history can be grouped into. Sub-hour
+ * windows are too expensive to compute and monthly windows are not supported.
+ */
+export type EntitlementHistoryWindowSize = 'PT1H' | 'P1D';
 /**
  * Filters on the given string field value by exact match. All properties are
  * optional; provide exactly one to specify the comparison.
@@ -6320,6 +7015,10 @@ export type StringFieldFilterExact = string | {
 };
 /** The payment term of a flat price. */
 export type PricePaymentTerm = 'in_advance' | 'in_arrears';
+/** Filter by a boolean value (true/false). */
+export type BooleanFieldFilter = boolean | {
+    eq: boolean;
+};
 /** Fiat or custom currency code. */
 export type BillingCurrencyCode = string | string;
 /** Fiat or custom currency code. */
@@ -6344,6 +7043,8 @@ export type DateTimeFieldFilter = Date | {
     gt?: Date;
     gte?: Date;
 };
+/** The time from which usage is measured, as a preset or an explicit timestamp. */
+export type EntitlementMeasureUsageFrom = 'current_period_start' | 'now' | Date;
 /** Payment settings for a billing workflow. */
 export type WorkflowPaymentSettings = WorkflowPaymentChargeAutomaticallySettings | WorkflowPaymentSendInvoiceSettings;
 /**
@@ -6399,6 +7100,8 @@ export type ChargeRealizationDetailedLine = ChargeRealizationDetailedLineFlatFee
 export type Currency = CurrencyFiat | CurrencyCustom;
 /** Customer or reference. */
 export type CustomerOrReference = Customer | CustomerReference;
+/** An entitlement grants a customer access to a feature. */
+export type Entitlement = EntitlementMetered | EntitlementStatic | EntitlementBoolean;
 /**
  * The alignment for collecting the pending line items into an invoice.
  *
@@ -6418,6 +7121,8 @@ export type Price = PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVo
 export type PriceUsageBased = PriceUnit | PriceGraduated | PriceVolume;
 /** Price. */
 export type UpdatePrice = UpdatePriceFree | UpdatePriceFlat | UpdatePriceUnit | UpdatePriceGraduated | UpdatePriceVolume;
+/** Entitlement create request. */
+export type CreateEntitlementRequest = CreateEntitlementMeteredRequest | CreateEntitlementStaticRequest | CreateEntitlementBooleanRequest;
 /** Installed application. */
 export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Response of the app install. */
@@ -6546,6 +7251,19 @@ export interface UpdateBillingWorkflowPaymentSendInvoiceSettingsInput {
      */
     dueAfter?: string;
 }
+/**
+ * Usage granted automatically after each reset of a metered entitlement. The
+ * balance returns to `amount` after every reset.
+ */
+export interface EntitlementIssueAfterResetInput {
+    /** The amount granted after each reset, in the feature's unit. */
+    amount: string;
+    /**
+     * The priority of the grant created after each reset. Lower values have higher
+     * priority.
+     */
+    priority?: number;
+}
 /** Metering event following the CloudEvents specification. */
 export interface EventInput {
     /** Identifies the event. */
@@ -6576,6 +7294,24 @@ export interface EventInput {
     /** The event payload. Optional, if present it must be a JSON object. */
     data?: Record<string, unknown> | null;
 }
+/** Request body for resetting the usage of a metered entitlement. */
+export interface ResetCustomerEntitlementUsageRequestInput {
+    /**
+     * The time the reset takes effect. Defaults to the current time and cannot be in
+     * the future. Truncated to the minute.
+     */
+    effectiveAt?: Date;
+    /**
+     * Whether the usage period anchor is kept. When false, the anchor moves to
+     * `effective_at`.
+     */
+    retainAnchor?: boolean;
+    /**
+     * Whether overage carries over into the new usage period. Defaults to the
+     * entitlement's own setting.
+     */
+    preserveOverage?: boolean;
+}
 /** Unauthorized. */
 export interface UnauthorizedInput extends BaseErrorInput {
 }
@@ -6762,6 +7498,120 @@ export interface EntitlementAccessQueryRequestInput {
     customer: EntitlementAccessQueryRequestCustomers;
     feature?: EntitlementAccessQueryRequestFeatures;
 }
+/**
+ * A notification channel delivers notification events, such as entitlement balance
+ * threshold crossings, to an external system. Today the only supported channel
+ * type is a webhook delivered via Svix.
+ */
+export interface NotificationChannelInput {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: 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 type of the channel. Immutable after creation. */
+    type: 'webhook';
+    /**
+     * Whether the channel is disabled. Disabled channels do not receive notification
+     * events.
+     */
+    disabled?: boolean;
+    /** The URL that webhook notification events are delivered to. */
+    url: string;
+    /**
+     * Custom HTTP headers to include on every webhook delivery request, keyed by
+     * header name.
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * Secret used to sign outgoing webhook payloads so recipients can verify their
+     * authenticity. If omitted on create, a secret is generated automatically by the
+     * delivery provider. This is a sensitive credential returned in responses (unlike
+     * most secrets) specifically so clients can retrieve a server-generated value and
+     * verify webhook signatures; handle it with the same care as any other credential.
+     */
+    signingSecret?: string;
+}
+/** NotificationChannel create request. */
+export interface CreateNotificationChannelRequestInput {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of the channel. Immutable after creation. */
+    type: 'webhook';
+    /**
+     * Whether the channel is disabled. Disabled channels do not receive notification
+     * events.
+     */
+    disabled?: boolean;
+    /** The URL that webhook notification events are delivered to. */
+    url: string;
+    /**
+     * Custom HTTP headers to include on every webhook delivery request, keyed by
+     * header name.
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * Secret used to sign outgoing webhook payloads so recipients can verify their
+     * authenticity. If omitted on create, a secret is generated automatically by the
+     * delivery provider. This is a sensitive credential returned in responses (unlike
+     * most secrets) specifically so clients can retrieve a server-generated value and
+     * verify webhook signatures; handle it with the same care as any other credential.
+     */
+    signingSecret?: string;
+}
+/**
+ * Request body for updating a notification channel. Updates replace the channel's
+ * mutable state rather than merging it: `type`, `name`, and `url` must always be
+ * provided, and omitting `disabled`, `labels`, or `custom_headers` resets them to
+ * their defaults (enabled, no labels, no custom headers). `signing_secret` is the
+ * one exception: omitting it keeps the channel's current signing secret instead of
+ * clearing the credential.
+ */
+export interface UpdateBillingNotificationChannelRequestInput {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /** The type of the channel. Immutable after creation. */
+    type: 'webhook';
+    /** The URL that webhook notification events are delivered to. */
+    url: string;
+    labels?: Labels;
+    /**
+     * Whether the channel is disabled. Disabled channels do not receive notification
+     * events.
+     */
+    disabled?: boolean;
+    /**
+     * Custom HTTP headers to include on every webhook delivery request, keyed by
+     * header name.
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * Secret used to sign outgoing webhook payloads so recipients can verify their
+     * authenticity. If omitted on create, a secret is generated automatically by the
+     * delivery provider. This is a sensitive credential returned in responses (unlike
+     * most secrets) specifically so clients can retrieve a server-generated value and
+     * verify webhook signatures; handle it with the same care as any other credential.
+     */
+    signingSecret?: string;
+}
 /** An ingested metering event with ingestion metadata. */
 export interface IngestedEventInput {
     /** The original event ingested. */
@@ -6775,6 +7625,58 @@ export interface IngestedEventInput {
     /** The validation errors of the ingested event. */
     validationErrors?: IngestedEventValidationError[];
 }
+/**
+ * A metered entitlement grants a usage allowance for a feature. Access is
+ * determined by the balance: the allowance provided by grants is burnt down by
+ * usage.
+ */
+export interface EntitlementMeteredInput {
+    id: string;
+    /** The type of the entitlement. */
+    type: 'metered';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    /** The customer the entitlement belongs to. */
+    customer: CustomerReference;
+    labels?: Labels;
+    /** The time from which the entitlement is active. */
+    activeFrom: Date;
+    /**
+     * The time until which the entitlement is active. If not set, the entitlement is
+     * active until deleted.
+     */
+    activeTo?: Date;
+    /** The time the entitlement was created. */
+    createdAt: Date;
+    /** The time the entitlement was last updated. */
+    updatedAt: Date;
+    /** The time the entitlement was deleted. */
+    deletedAt?: Date;
+    /**
+     * The usage period of the entitlement. The balance resets at the start of every
+     * period.
+     */
+    usagePeriod: RecurringPeriod;
+    /** The current usage period of the entitlement. */
+    currentUsagePeriod: ClosedPeriod;
+    /**
+     * If true, the customer keeps access to the feature after the balance is
+     * exhausted.
+     */
+    isSoftLimit?: boolean;
+    /** Usage granted automatically after each reset. Cannot be combined with `grants`. */
+    issue?: EntitlementIssueAfterResetInput;
+    /** The amount granted automatically after each reset. */
+    issueAfterReset?: string;
+    /** The priority of the grant created after each reset. */
+    issueAfterResetPriority?: number;
+    /** If true, the overage is preserved at reset. If false, the usage is reset to 0. */
+    preserveOverageAtReset?: boolean;
+    /** The time from which usage is measured. */
+    measureUsageFrom: Date;
+    /** The time of the last reset. */
+    lastReset: Date;
+}
 /** Subscription fields without phases or the current billing period. */
 export interface SubscriptionBaseInput {
     id: string;
@@ -6906,6 +7808,11 @@ export interface UpdateBillingInvoiceWorkflowInput {
     /** Payment settings for this invoice. */
     payment?: UpdateBillingWorkflowPaymentSettingsInput;
 }
+/** Page paginated response. */
+export interface NotificationChannelPagePaginatedResponseInput {
+    data: NotificationChannelInput[];
+    meta: PaginatedMeta;
+}
 /** Purchase and payment terms of the grant. */
 export interface CreateCreditGrantPurchaseInput {
     /**
@@ -7130,6 +8037,39 @@ export interface AppStripeCreateCheckoutSessionRequestOptionsInput {
     /** Configuration for collecting tax IDs during checkout. */
     taxIdCollection?: AppStripeCreateCheckoutSessionTaxIdCollectionInput;
 }
+/** Metered entitlement create request. */
+export interface CreateEntitlementMeteredRequestInput {
+    /** The type of the entitlement. */
+    type: 'metered';
+    /** The feature the customer is entitled to use. */
+    feature: FeatureReference;
+    labels?: Labels;
+    /**
+     * If true, the customer keeps access to the feature after the balance is
+     * exhausted.
+     */
+    isSoftLimit?: boolean;
+    /** Usage granted automatically after each reset. Cannot be combined with `grants`. */
+    issue?: EntitlementIssueAfterResetInput;
+    /** The amount granted automatically after each reset. */
+    issueAfterReset?: string;
+    /** The priority of the grant created after each reset. */
+    issueAfterResetPriority?: number;
+    /** If true, the overage is preserved at reset. If false, the usage is reset to 0. */
+    preserveOverageAtReset?: boolean;
+    /**
+     * The usage period of the entitlement. The balance resets at the start of every
+     * period. The anchor defaults to the entitlement creation time.
+     */
+    usagePeriod: RecurringPeriodInput;
+    /**
+     * The time from which usage is measured. Defaults to the entitlement creation
+     * time.
+     */
+    measureUsageFrom?: EntitlementMeasureUsageFrom;
+    /** Grants created together with the entitlement. Cannot be combined with `issue`. */
+    grants?: EntitlementGrantCreateRequest[];
+}
 /** Snapshot of the billing workflow configuration captured at invoice creation. */
 export interface InvoiceWorkflowSettingsInput {
     /** The apps that will be used to orchestrate the invoice's workflow. */
@@ -7238,7 +8178,7 @@ export interface CreateCreditGrantRequestInput {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreateCreditGrantTaxConfig;
+    taxConfig?: CreateTaxCodeConfig;
     filters?: CreateCreditGrantFilters;
     /** Draw-down priority of the grant. Lower values have higher priority. */
     priority?: number;
@@ -7311,7 +8251,7 @@ export interface CreditGrantInput {
      * credit grant tax code is applied, if that's not set the global default taxcode
      * is used.
      */
-    taxConfig?: CreditGrantTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** Available when `funding_method` is `invoice`. */
     invoice?: CreditGrantInvoiceReference;
     filters?: CreditGrantFilters;
@@ -7370,6 +8310,11 @@ export interface CustomerStripeCreateCheckoutSessionRequestInput {
      */
     stripeOptions: AppStripeCreateCheckoutSessionRequestOptionsInput;
 }
+/** Page paginated response. */
+export interface EntitlementPagePaginatedResponseInput {
+    data: EntitlementInput[];
+    meta: PaginatedMeta;
+}
 /**
  * Workflow collection specifies how to collect the pending line items for an
  * invoice.
@@ -7517,7 +8462,7 @@ export interface RateCardInput {
     /** The discounts of the rate card. */
     discounts?: RateCardDiscounts;
     /** The tax config of the rate card. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /**
      * The entitlement template granted to subscribers of a plan or addon containing
      * this rate card. Requires `feature` to be set.
@@ -7529,7 +8474,7 @@ export interface InvoiceLineRateCardInput {
     /** The price definition used to calculate charges for this line. */
     price: Price;
     /** Tax configuration snapshot for this line. */
-    taxConfig?: RateCardTaxConfig;
+    taxConfig?: TaxCodeConfig;
     /** The feature key associated with this line's rate card. */
     featureKey?: string;
     /** Discount configuration from the rate card. */
@@ -8965,6 +9910,10 @@ export type UpdateBillingWorkflowPaymentSettingsInput = UpdateBillingWorkflowPay
  * rate card itself, so it is omitted here.
  */
 export type RateCardEntitlementInput = RateCardMeteredEntitlementInput | RateCardStaticEntitlement | RateCardBooleanEntitlement;
+/** An entitlement grants a customer access to a feature. */
+export type EntitlementInput = EntitlementMeteredInput | EntitlementStatic | EntitlementBoolean;
+/** Entitlement create request. */
+export type CreateEntitlementRequestInput = CreateEntitlementMeteredRequestInput | CreateEntitlementStaticRequest | CreateEntitlementBooleanRequest;
 /** ChargeRealizationInvoice or reference. */
 export type ChargeRealizationInvoiceOrReferenceInput = ChargeRealizationInvoiceInput | ChargeRealizationInvoiceReference;
 /** Customer charge. */