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

package/dist/models/types.d.ts

@@ -283,6 +283,14 @@ export interface SubscriptionEditUnscheduleEdit {
  * "mesh", "kic", or "\_".
  */
 export type UpdateLabels = Record<string, string>;
+/**
+ * Request to reconcile the app's webhook events with the latest supported event
+ * set.
+ */
+export interface AppReconcileWebhookEventsActionRequest {
+    /** The action to execute. */
+    actionType: 'reconcile_webhook_events';
+}
 /** Model for installing an app from the catalog with an API key. */
 export interface InstallAppStripeWithApiKey {
     /** Type of the app. */
@@ -309,15 +317,15 @@ export interface InstallAppSandbox {
      */
     createBillingProfile: boolean;
 }
-/** Base model for installing an app from the catalog. */
+/** Model for installing an External Invoicing 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.
+     * If true, creates the Auto Collection preset with an OpenMeter supplier in the US
+     * (postal code 94114), without replacing the default profile.
      */
     createBillingProfile: boolean;
 }
@@ -416,6 +424,23 @@ export interface EntitlementAccessQueryRequestFeatures {
     /** List of feature keys to evaluate access for. */
     keys: string[];
 }
+/**
+ * The response the recipient returned for a delivery attempt. For webhook channels
+ * this is the HTTP response.
+ */
+export interface NotificationEventDeliveryAttemptResponse {
+    /**
+     * The HTTP status code returned by the recipient. Absent when no response was
+     * received.
+     */
+    statusCode?: number;
+    /** The response body returned by the recipient. Empty when no body was received. */
+    body: string;
+    /** How long the delivery attempt took, in milliseconds. */
+    durationMs: bigint;
+    /** The URL the event was delivered to. Only set for webhook channels. */
+    url?: string;
+}
 /**
  * A query filter for an integer attribute. Operators are mutually exclusive, only
  * one operator is allowed at a time.
@@ -1037,6 +1062,33 @@ export interface ChargeReference {
 export interface UpdateResourceReference {
     id: string;
 }
+/** NotificationChannel reference. */
+export interface NotificationChannelReference {
+    id: string;
+}
+/** A reference to the feature of an entitlement notification event. */
+export interface NotificationEventFeatureReference {
+    /** The unique identifier of the feature. */
+    id: string;
+    /** The immutable key of the feature. */
+    key: string;
+}
+/** A reference to the invoice of an invoice notification event. */
+export interface NotificationEventInvoiceReference {
+    /** The unique identifier of the invoice. */
+    id: string;
+    /** The human-readable invoice number. */
+    number: string;
+}
+/** Request body for resending a notification event. */
+export interface ResendBillingNotificationEventRequest {
+    /**
+     * The channels to resend the event to. When omitted or empty, the event is resent
+     * to every enabled channel of the rule. Channels not targeted by the rule or
+     * disabled are rejected.
+     */
+    channels?: string[];
+}
 /** Customer reference. */
 export interface BillingCustomerReference {
     /** The ID of the customer. */
@@ -2150,6 +2202,13 @@ export interface AppCapability {
     /** Description of the capability. */
     description: string;
 }
+/** An action the operator should take on an installed app. */
+export interface AppAction {
+    /** The action type. */
+    type: 'reconcile_webhook_events';
+    /** Human readable explanation of why the action is needed. */
+    description: string;
+}
 /** AppStripe update request. */
 export interface UpdateAppStripeRequest {
     /**
@@ -2429,6 +2488,34 @@ export interface UpdateBillingNotificationChannelRequest {
      */
     signingSecret?: string;
 }
+/**
+ * A balance threshold of a notification rule. Crossing it generates an
+ * `entitlements.balance.threshold` event.
+ */
+export interface NotificationBalanceThreshold {
+    /** What the threshold value is measured against. */
+    type: 'balance_value' | 'usage_percentage' | 'usage_value';
+    /** The threshold value. */
+    value: number;
+}
+/** A reference to the notification rule that generated an event. */
+export interface NotificationRuleReference {
+    /** The unique identifier of the rule. */
+    id: string;
+    /** The type of event the rule generates. */
+    type: 'entitlements.balance.threshold' | 'entitlements.reset' | 'invoice.created' | 'invoice.updated';
+    /** The user-provided name of the rule. */
+    name: string;
+}
+/** A single delivery attempt to a channel. */
+export interface NotificationEventDeliveryAttempt {
+    /** The delivery state reached by this attempt. */
+    state: 'success' | 'failed' | 'sending' | 'pending' | 'resending';
+    /** The response returned by the recipient. */
+    response: NotificationEventDeliveryAttemptResponse;
+    /** When the attempt was made. */
+    timestamp: Date;
+}
 /** App customer data. */
 export interface AppCustomerData {
     /**
@@ -3061,6 +3148,170 @@ export interface UpdateTaxCodeConfig {
     /** Tax code applied to the invoice line item. */
     code?: UpdateResourceReference;
 }
+/** A rule that generates an event when an entitlement usage period is reset. */
+export interface NotificationRuleEntitlementReset {
+    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 event the rule generates. Immutable after creation. */
+    type: 'entitlements.reset';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/** A rule that generates an event when an invoice is created. */
+export interface NotificationRuleInvoiceCreated {
+    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 event the rule generates. Immutable after creation. */
+    type: 'invoice.created';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** A rule that generates an event when an invoice is updated. */
+export interface NotificationRuleInvoiceUpdated {
+    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 event the rule generates. Immutable after creation. */
+    type: 'invoice.updated';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** Request body for an entitlement reset rule. */
+export interface NotificationRuleEntitlementResetRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'entitlements.reset';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/** Request body for an invoice created rule. */
+export interface NotificationRuleInvoiceCreatedRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'invoice.created';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** Request body for an invoice updated rule. */
+export interface NotificationRuleInvoiceUpdatedRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'invoice.updated';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** The invoice an invoice notification event refers to. */
+export interface NotificationEventInvoiceData {
+    /** The invoice the event was generated for. */
+    invoice: NotificationEventInvoiceReference;
+    /** The identifier of the customer the invoice was issued to. */
+    customerId?: string;
+    /** The currency the invoice is denominated in. */
+    currency: string;
+    /** The status of the invoice at the time the event was generated. */
+    status: string;
+    /** The invoice total, including taxes, at the time the event was generated. */
+    total: string;
+}
 /** Filter options for listing ingested events. */
 export interface ListEventsParamsFilter {
     /** Filter events by ID. */
@@ -3152,6 +3403,57 @@ export interface ListNotificationChannelsParamsFilter {
     createdAt?: DateTimeFieldFilter;
     updatedAt?: DateTimeFieldFilter;
 }
+/** Filter options for listing notification rules. */
+export interface ListNotificationRulesParamsFilter {
+    id?: UlidFieldFilter;
+    name?: StringFieldFilter;
+    type?: StringFieldFilterExact;
+    disabled?: BooleanFieldFilter;
+    createdAt?: DateTimeFieldFilter;
+    updatedAt?: DateTimeFieldFilter;
+    /**
+     * Filter by an assigned channel. Matches rules that deliver to at least one of the
+     * given channels. Only `eq` and `oeq` are supported.
+     */
+    channelId?: UlidFieldFilter;
+}
+/** Filter options for listing notification events. */
+export interface ListNotificationEventsParamsFilter {
+    id?: UlidFieldFilter;
+    type?: StringFieldFilterExact;
+    createdAt?: DateTimeFieldFilter;
+    ruleId?: UlidFieldFilter;
+    /**
+     * Filter by a channel of the generating rule. Matches events whose rule targets at
+     * least one of the given channels. Only `eq` and `oeq` are supported.
+     */
+    channelId?: UlidFieldFilter;
+    /**
+     * Filter by delivery state. Matches events where delivery to at least one channel
+     * is in one of the given states. Only `eq` and `oeq` are supported.
+     */
+    deliveryStatus?: StringFieldFilterExact;
+    /**
+     * Filter by the key of the subject the event refers to. Events without a subject
+     * never match, not even with `neq`.
+     */
+    subjectKey?: StringFieldFilterExact;
+    /**
+     * Filter by the id of the subject the event refers to. Events without a subject
+     * never match, not even with `neq`.
+     */
+    subjectId?: UlidFieldFilter;
+    /**
+     * Filter by the key of the feature the event refers to. Events without a feature
+     * never match, not even with `neq`.
+     */
+    featureKey?: StringFieldFilterExact;
+    /**
+     * Filter by the id of the feature the event refers to. Events without a feature
+     * never match, not even with `neq`.
+     */
+    featureId?: UlidFieldFilter;
+}
 /** Resource filters. */
 export interface ResourceFilters {
     name?: StringFieldFilter;
@@ -4096,6 +4398,91 @@ export interface NotificationChannelPagePaginatedResponse {
     data: NotificationChannel[];
     meta: PaginatedMeta;
 }
+/**
+ * A rule that generates an event when an entitlement balance crosses one of its
+ * thresholds.
+ */
+export interface NotificationRuleBalanceThreshold {
+    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 event the rule generates. Immutable after creation. */
+    type: 'entitlements.balance.threshold';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /** The thresholds that generate an event when crossed. */
+    thresholds: NotificationBalanceThreshold[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/** Request body for a balance threshold rule. */
+export interface NotificationRuleBalanceThresholdRequest {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'entitlements.balance.threshold';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /** The thresholds that generate an event when crossed. */
+    thresholds: NotificationBalanceThreshold[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/**
+ * The delivery status of a notification event for one channel of the generating
+ * rule.
+ */
+export interface NotificationEventDeliveryStatus {
+    /** The identifier of the channel this delivery status belongs to. */
+    channelId: string;
+    /** The current delivery state. */
+    state: 'success' | 'failed' | 'sending' | 'pending' | 'resending';
+    /** The reason for the last state change. Empty for successful deliveries. */
+    reason: string;
+    /** When the delivery state was last updated. */
+    updatedAt: Date;
+    /**
+     * When the next delivery attempt is scheduled. Absent when no further attempts
+     * will be made.
+     */
+    nextAttempt?: Date;
+    /** The delivery attempts made so far, most recent first. */
+    attempts: NotificationEventDeliveryAttempt[];
+}
 /** Billing customer data. */
 export interface CustomerData {
     /**
@@ -4163,6 +4550,37 @@ export interface ListCustomerEntitlementAccessResponseData {
     /** The list of entitlement access results. */
     data: EntitlementValueResult[];
 }
+/** The entities and threshold a balance threshold event refers to. */
+export interface NotificationEventBalanceThresholdData {
+    /** The identifier of the entitlement that triggered the event. */
+    entitlementId: string;
+    /** The feature the entitlement grants access to. */
+    feature: NotificationEventFeatureReference;
+    /** The key of the subject the entitlement belongs to. */
+    subjectKey: string;
+    /** The identifier of the customer the subject belongs to, if any. */
+    customerId?: string;
+    /** The entitlement value at the time the event was generated. */
+    value: EntitlementValueResult;
+    /** The threshold the balance crossed. */
+    threshold: NotificationBalanceThreshold;
+}
+/**
+ * The entitlement, feature, and subject an entitlement notification event refers
+ * to.
+ */
+export interface NotificationEventEntitlementData {
+    /** The identifier of the entitlement that triggered the event. */
+    entitlementId: string;
+    /** The feature the entitlement grants access to. */
+    feature: NotificationEventFeatureReference;
+    /** The key of the subject the entitlement belongs to. */
+    subjectKey: string;
+    /** The identifier of the customer the subject belongs to, if any. */
+    customerId?: string;
+    /** The entitlement value at the time the event was generated. */
+    value: EntitlementValueResult;
+}
 /**
  * Graduated tiered price.
  *
@@ -4400,6 +4818,28 @@ export interface PlanAddonPagePaginatedResponse {
     data: PlanAddon[];
     meta: PaginatedMeta;
 }
+/** An invoice created notification event payload. */
+export interface NotificationEventInvoiceCreatedPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'invoice.created';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The invoice the event refers to. */
+    data: NotificationEventInvoiceData;
+}
+/** An invoice updated notification event payload. */
+export interface NotificationEventInvoiceUpdatedPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'invoice.updated';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The invoice the event refers to. */
+    data: NotificationEventInvoiceData;
+}
 /** Cursor paginated response. */
 export interface IngestedEventPaginatedResponse {
     data: IngestedEvent[];
@@ -4684,6 +5124,11 @@ export interface AppStripe {
     definition: AppCatalogItem;
     /** Status of the app connection. */
     status: 'ready' | 'unauthorized';
+    /**
+     * Actions the operator should take to bring the app up to date. Omitted when no
+     * action is required.
+     */
+    actions?: AppAction[];
     /** The Stripe account ID associated with the connected Stripe account. */
     accountId: string;
     /** Indicates whether the app is connected to a live Stripe account. */
@@ -4719,6 +5164,11 @@ export interface AppSandbox {
     definition: AppCatalogItem;
     /** Status of the app connection. */
     status: 'ready' | 'unauthorized';
+    /**
+     * Actions the operator should take to bring the app up to date. Omitted when no
+     * action is required.
+     */
+    actions?: AppAction[];
 }
 /**
  * External Invoicing app enables integration with third-party invoicing or payment
@@ -4766,6 +5216,11 @@ export interface AppExternalInvoicing {
     definition: AppCatalogItem;
     /** Status of the app connection. */
     status: 'ready' | 'unauthorized';
+    /**
+     * Actions the operator should take to bring the app up to date. Omitted when no
+     * action is required.
+     */
+    actions?: AppAction[];
     /**
      * Enable draft synchronization hook.
      *
@@ -4824,6 +5279,11 @@ export interface InstalledAppStripe {
     definition: AppCatalogItem;
     /** Status of the app connection. */
     status: 'ready' | 'unauthorized';
+    /**
+     * Actions the operator should take to bring the app up to date. Omitted when no
+     * action is required.
+     */
+    actions?: AppAction[];
     /** The Stripe account ID associated with the connected Stripe account. */
     accountId: string;
     /** Indicates whether the app is connected to a live Stripe account. */
@@ -4861,6 +5321,11 @@ export interface InstalledAppSandbox {
     definition: AppCatalogItem;
     /** Status of the app connection. */
     status: 'ready' | 'unauthorized';
+    /**
+     * Actions the operator should take to bring the app up to date. Omitted when no
+     * action is required.
+     */
+    actions?: AppAction[];
     /** Default capabilities of the installed app. */
     defaultForCapabilityTypes: ('report_usage' | 'report_events' | 'calculate_tax' | 'invoice_customers' | 'collect_payments')[];
 }
@@ -4892,6 +5357,11 @@ export interface InstalledAppExternalInvoicing {
     definition: AppCatalogItem;
     /** Status of the app connection. */
     status: 'ready' | 'unauthorized';
+    /**
+     * Actions the operator should take to bring the app up to date. Omitted when no
+     * action is required.
+     */
+    actions?: AppAction[];
     /**
      * Enable draft synchronization hook.
      *
@@ -5001,6 +5471,28 @@ export interface EntitlementAccessQueryResult {
      */
     updatedAt: Date;
 }
+/** A balance threshold notification event payload. */
+export interface NotificationEventBalanceThresholdPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'entitlements.balance.threshold';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The entities and threshold the event refers to. */
+    data: NotificationEventBalanceThresholdData;
+}
+/** An entitlement reset notification event payload. */
+export interface NotificationEventResetPayload {
+    /** The identifier of the event the payload belongs to. */
+    id: string;
+    /** The type of the event. */
+    type: 'entitlements.reset';
+    /** When the event was generated. */
+    timestamp: Date;
+    /** The entities the event refers to. */
+    data: NotificationEventEntitlementData;
+}
 /** A capability or billable dimension offered by a provider. */
 export interface Feature {
     id: string;
@@ -5411,6 +5903,11 @@ export interface EntitlementAccessQueryResponse {
      */
     meta: CursorMeta;
 }
+/** Page paginated response. */
+export interface NotificationRulePagePaginatedResponse {
+    data: NotificationRule[];
+    meta: PaginatedMeta;
+}
 /** A rate card defines the pricing and entitlement of a feature or service. */
 export interface RateCard {
     /**
@@ -5653,6 +6150,25 @@ export interface ProfileApps {
     /** The payment app used for this workflow. */
     payment: App;
 }
+/**
+ * A notification event records that a notification rule fired and tracks the
+ * delivery of its payload to each channel of the rule. Events are created by the
+ * system and cannot be modified.
+ */
+export interface NotificationEvent {
+    /** The unique identifier of the event. */
+    id: string;
+    /** The type of the event. */
+    type: 'entitlements.balance.threshold' | 'entitlements.reset' | 'invoice.created' | 'invoice.updated';
+    /** When the event was generated. */
+    createdAt: Date;
+    /** The rule that generated the event. */
+    rule: NotificationRuleReference;
+    /** The delivery status of the event, one entry per channel of the rule. */
+    deliveryStatus: NotificationEventDeliveryStatus[];
+    /** The payload delivered to the channels. */
+    payload: NotificationEventPayload;
+}
 /** A subscription item pins a rate card to a cadence within a subscription phase. */
 export interface SubscriptionItem {
     /** The unique identifier of the subscription item instance. */
@@ -6090,6 +6606,11 @@ export interface ChargeRealization {
      */
     detailedLines?: ChargeRealizationDetailedLine[];
 }
+/** Page paginated response. */
+export interface NotificationEventPagePaginatedResponse {
+    data: NotificationEvent[];
+    meta: PaginatedMeta;
+}
 /**
  * A subscription phase groups the rate cards in effect for a segment of the
  * subscription's lifetime. Analogous to plan phases.
@@ -7058,6 +7579,8 @@ export type SubscriptionCreateTiming = 'immediate' | Date;
  * returned.
  */
 export type SubscriptionEditTiming = 'immediate' | 'next_billing_cycle' | Date;
+/** Request to execute an operator action on an installed app. */
+export type AppActionRequest = AppReconcileWebhookEventsActionRequest;
 /** Request to install an app from the catalog. */
 export type InstallAppRequest = InstallAppStripeWithApiKey | InstallAppSandbox | InstallAppExternalInvoicing;
 /** Payment settings for a billing workflow. */
@@ -7110,6 +7633,17 @@ export type Entitlement = EntitlementMetered | EntitlementStatic | EntitlementBo
  * arrears items).
  */
 export type WorkflowCollectionAlignment = WorkflowCollectionAlignmentSubscription | WorkflowCollectionAlignmentAnchored;
+/**
+ * A notification rule selects the type of event to generate, the conditions
+ * specific to that type, and the channels to deliver the events to.
+ */
+export type NotificationRule = NotificationRuleBalanceThreshold | NotificationRuleEntitlementReset | NotificationRuleInvoiceCreated | NotificationRuleInvoiceUpdated;
+/**
+ * Request body for creating or updating a notification rule. Updates replace the
+ * rule's mutable state: omitting `disabled`, `labels`, or `features` resets them
+ * to their defaults. The `type` must match the existing rule on update.
+ */
+export type NotificationRuleRequest = NotificationRuleBalanceThresholdRequest | NotificationRuleEntitlementResetRequest | NotificationRuleInvoiceCreatedRequest | NotificationRuleInvoiceUpdatedRequest;
 /** Price. */
 export type Price = PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
 /**
@@ -7127,6 +7661,8 @@ export type CreateEntitlementRequest = CreateEntitlementMeteredRequest | CreateE
 export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Response of the app install. */
 export type BillingInstallAppResponse = InstalledAppStripe | InstalledAppSandbox | InstalledAppExternalInvoicing;
+/** The payload delivered to the channels, discriminated by the event type. */
+export type NotificationEventPayload = NotificationEventBalanceThresholdPayload | NotificationEventResetPayload | NotificationEventInvoiceCreatedPayload | NotificationEventInvoiceUpdatedPayload;
 /** Feature or reference. */
 export type FeatureOrReference = Feature | FeatureReference;
 /** ChargeRealizationInvoice or reference. */
@@ -7612,6 +8148,157 @@ export interface UpdateBillingNotificationChannelRequestInput {
      */
     signingSecret?: string;
 }
+/** A rule that generates an event when an entitlement usage period is reset. */
+export interface NotificationRuleEntitlementResetInput {
+    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 event the rule generates. Immutable after creation. */
+    type: 'entitlements.reset';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/** A rule that generates an event when an invoice is created. */
+export interface NotificationRuleInvoiceCreatedInput {
+    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 event the rule generates. Immutable after creation. */
+    type: 'invoice.created';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** A rule that generates an event when an invoice is updated. */
+export interface NotificationRuleInvoiceUpdatedInput {
+    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 event the rule generates. Immutable after creation. */
+    type: 'invoice.updated';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** Request body for an entitlement reset rule. */
+export interface NotificationRuleEntitlementResetRequestInput {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'entitlements.reset';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/** Request body for an invoice created rule. */
+export interface NotificationRuleInvoiceCreatedRequestInput {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'invoice.created';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
+/** Request body for an invoice updated rule. */
+export interface NotificationRuleInvoiceUpdatedRequestInput {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'invoice.updated';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+}
 /** An ingested metering event with ingestion metadata. */
 export interface IngestedEventInput {
     /** The original event ingested. */
@@ -7813,6 +8500,70 @@ export interface NotificationChannelPagePaginatedResponseInput {
     data: NotificationChannelInput[];
     meta: PaginatedMeta;
 }
+/**
+ * A rule that generates an event when an entitlement balance crosses one of its
+ * thresholds.
+ */
+export interface NotificationRuleBalanceThresholdInput {
+    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 event the rule generates. Immutable after creation. */
+    type: 'entitlements.balance.threshold';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /** The thresholds that generate an event when crossed. */
+    thresholds: NotificationBalanceThreshold[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
+/** Request body for a balance threshold rule. */
+export interface NotificationRuleBalanceThresholdRequestInput {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    labels?: Labels;
+    /** The type of event the rule generates. Immutable after creation. */
+    type: 'entitlements.balance.threshold';
+    /** Whether the rule is disabled. Disabled rules do not generate events. */
+    disabled?: boolean;
+    /**
+     * The channels the rule delivers its events to. At least one and at most five
+     * channels are required. Responses omit channels that have since been disabled or
+     * deleted.
+     */
+    channels: NotificationChannelReference[];
+    /** The thresholds that generate an event when crossed. */
+    thresholds: NotificationBalanceThreshold[];
+    /**
+     * The features the rule applies to. When omitted, the rule applies to every
+     * feature.
+     */
+    features?: FeatureReference[];
+}
 /** Purchase and payment terms of the grant. */
 export interface CreateCreditGrantPurchaseInput {
     /**
@@ -8408,6 +9159,11 @@ export interface ChargeRealizationInvoiceInput {
     /** Workflow configuration snapshot captured at invoice creation time. */
     workflow: InvoiceWorkflowSettingsInput;
 }
+/** Page paginated response. */
+export interface NotificationRulePagePaginatedResponseInput {
+    data: NotificationRuleInput[];
+    meta: PaginatedMeta;
+}
 /** A rate card defines the pricing and entitlement of a feature or service. */
 export interface RateCardInput {
     /**
@@ -9912,6 +10668,17 @@ export type UpdateBillingWorkflowPaymentSettingsInput = UpdateBillingWorkflowPay
 export type RateCardEntitlementInput = RateCardMeteredEntitlementInput | RateCardStaticEntitlement | RateCardBooleanEntitlement;
 /** An entitlement grants a customer access to a feature. */
 export type EntitlementInput = EntitlementMeteredInput | EntitlementStatic | EntitlementBoolean;
+/**
+ * A notification rule selects the type of event to generate, the conditions
+ * specific to that type, and the channels to deliver the events to.
+ */
+export type NotificationRuleInput = NotificationRuleBalanceThresholdInput | NotificationRuleEntitlementResetInput | NotificationRuleInvoiceCreatedInput | NotificationRuleInvoiceUpdatedInput;
+/**
+ * Request body for creating or updating a notification rule. Updates replace the
+ * rule's mutable state: omitting `disabled`, `labels`, or `features` resets them
+ * to their defaults. The `type` must match the existing rule on update.
+ */
+export type NotificationRuleRequestInput = NotificationRuleBalanceThresholdRequestInput | NotificationRuleEntitlementResetRequestInput | NotificationRuleInvoiceCreatedRequestInput | NotificationRuleInvoiceUpdatedRequestInput;
 /** Entitlement create request. */
 export type CreateEntitlementRequestInput = CreateEntitlementMeteredRequestInput | CreateEntitlementStaticRequest | CreateEntitlementBooleanRequest;
 /** ChargeRealizationInvoice or reference. */