@openmeter/sdk 1.0.0-beta.227 → 1.0.0-beta.228

package/dist/cjs/src/client/schemas.d.cts

@@ -975,7 +975,6 @@ export interface paths {
          * @description Features are either metered or static. A feature is metered if meterSlug is provided at creation.
          *     For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
          *     Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
-         *     Features cannot be updated later, only archived.
          */
         post: operations['createFeature'];
         delete?: never;
@@ -3258,6 +3257,14 @@ export interface components {
             /** @description The billing workflow settings for this profile. */
             workflow: components['schemas']['BillingWorkflow'];
         };
+        /**
+         * @description The settlement mode of a plan.
+         *     It determines how the billing system generates invoices and credits for the subscriptions using this plan.
+         *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.
+         *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+         * @enum {string}
+         */
+        BillingSettlementMode: 'credit_then_invoice' | 'credit_only';
         /** @description TaxIdentificationCode is a normalized tax code shown on the original identity document. */
         BillingTaxIdentificationCode: string;
         /** @description BillingWorkflow represents the settings for a billing workflow. */
@@ -4033,6 +4040,16 @@ export interface components {
              *     }
              */
             proRatingConfig?: components['schemas']['ProRatingConfig'];
+            /**
+             * Settlement mode
+             * @description The settlement mode of the plan.
+             *     It determines how the billing system generates invoices and credits for the subscriptions using this plan.
+             *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
+             *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+             *     This is the default and most common settlement mode.
+             * @default credit_then_invoice
+             */
+            settlementMode?: components['schemas']['BillingSettlementMode'];
             /**
              * Plan phases
              * @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
@@ -5773,6 +5790,50 @@ export interface components {
              */
             readonly config?: string;
         };
+        /** @description EntitlementValueV2 returns entitlement access state and value fields for customer-scoped V2 APIs. */
+        EntitlementValueV2: {
+            /**
+             * @description Whether the subject has access to the feature. Shared accross all entitlement types.
+             * @example true
+             */
+            readonly hasAccess: boolean;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. Metered entitlements are built around a balance calculation where feature usage is deducted from the issued grants. Balance represents the remaining balance of the entitlement, it's value never turns negative.
+             * @example 100
+             */
+            readonly balance?: number;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. Returns the total feature usage in the current period.
+             * @example 50
+             */
+            readonly usage?: number;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. Overage represents the usage that wasn't covered by grants, e.g. if the subject had a total feature usage of 100 in the period but they were only granted 80, there would be 20 overage.
+             * @example 0
+             */
+            readonly overage?: number;
+            /**
+             * Format: double
+             * @description Only available for metered entitlements. The summed amount of all grant active at query time PLUS the used amount of since inactive grants.
+             * @example 100
+             */
+            readonly totalAvailableGrantAmount?: number;
+            /**
+             * @description Only available for static entitlements. The JSON parsable config of the entitlement.
+             * @example { key: "value" }
+             */
+            readonly config?: string;
+            /**
+             * @description Only available for metered entitlements. The closing balance of each active grant at query time.
+             *     The key is the grant ID and the value is the remaining balance.
+             */
+            readonly grantBalances?: {
+                [key: string]: number;
+            };
+        };
         /** @description Generic ErrorExtension as part of HTTPProblem.Extensions.[StatusCode] */
         ErrorExtension: {
             /**
@@ -5988,6 +6049,13 @@ export interface components {
             advancedMeterGroupByFilters?: {
                 [key: string]: components['schemas']['FilterString'];
             };
+            /**
+             * Unit cost
+             * @description Optional per-unit cost configuration.
+             *     Use "manual" for a fixed per-unit cost, or "llm" to look up cost
+             *     from the LLM cost database based on meter group-by properties.
+             */
+            unitCost?: components['schemas']['FeatureUnitCost'];
             /**
              * @description Readonly unique ULID identifier.
              * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
@@ -6055,6 +6123,113 @@ export interface components {
             advancedMeterGroupByFilters?: {
                 [key: string]: components['schemas']['FilterString'];
             };
+            /**
+             * Unit cost
+             * @description Optional per-unit cost configuration.
+             *     Use "manual" for a fixed per-unit cost, or "llm" to look up cost
+             *     from the LLM cost database based on meter group-by properties.
+             */
+            unitCost?: components['schemas']['FeatureUnitCost'];
+        };
+        /**
+         * @description LLM cost lookup configuration.
+         *     Maps meter group-by dimensions to LLM cost database fields.
+         */
+        FeatureLLMUnitCost: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'llm';
+            /**
+             * Provider property
+             * @description Meter group-by property that holds the LLM provider.
+             *     Use this when the meter has a group-by dimension for provider.
+             *     Mutually exclusive with `provider`.
+             */
+            providerProperty?: string;
+            /**
+             * Provider
+             * @description Static LLM provider value (e.g., "openai", "anthropic").
+             *     Use this when the feature tracks a single provider.
+             *     Mutually exclusive with `providerProperty`.
+             */
+            provider?: string;
+            /**
+             * Model property
+             * @description Meter group-by property that holds the model ID.
+             *     Use this when the meter has a group-by dimension for model.
+             *     Mutually exclusive with `model`.
+             */
+            modelProperty?: string;
+            /**
+             * Model
+             * @description Static model ID value (e.g., "gpt-4", "claude-3-5-sonnet").
+             *     Use this when the feature tracks a single model.
+             *     Mutually exclusive with `modelProperty`.
+             */
+            model?: string;
+            /**
+             * Token type property
+             * @description Meter group-by property that holds the token type.
+             *     Use this when the meter has a group-by dimension for token type.
+             *     Mutually exclusive with `tokenType`.
+             */
+            tokenTypeProperty?: string;
+            /**
+             * Token type
+             * @description Static token type value.
+             *     Use this when the feature tracks a single token type (e.g., only input tokens).
+             *     Expected values: input, output, cache_read, reasoning, cache_write, request, response.
+             *     `request` is an alias for `input`, `response` is an alias for `output`.
+             *     Mutually exclusive with `tokenTypeProperty`.
+             */
+            tokenType?: string;
+            /**
+             * Resolved pricing
+             * @description Resolved per-token pricing from the LLM cost database.
+             *     Only populated in responses when the feature's meter group-by filters
+             *     specify exact provider and model values.
+             */
+            readonly pricing?: components['schemas']['FeatureLLMUnitCostPricing'];
+        };
+        /** @description Resolved per-token pricing from the LLM cost database. */
+        FeatureLLMUnitCostPricing: {
+            /**
+             * Input per token
+             * @description Cost per input token in USD.
+             */
+            inputPerToken: components['schemas']['Numeric'];
+            /**
+             * Output per token
+             * @description Cost per output token in USD.
+             */
+            outputPerToken: components['schemas']['Numeric'];
+            /**
+             * Cache read per token
+             * @description Cost per cache read token in USD.
+             */
+            cacheReadPerToken?: components['schemas']['Numeric'];
+            /**
+             * Reasoning per token
+             * @description Cost per reasoning token in USD.
+             */
+            reasoningPerToken?: components['schemas']['Numeric'];
+            /**
+             * Cache write per token
+             * @description Cost per cache write token in USD.
+             */
+            cacheWritePerToken?: components['schemas']['Numeric'];
+        };
+        /** @description A fixed per-unit cost amount. */
+        FeatureManualUnitCost: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'manual';
+            /** @description Fixed per-unit cost amount in USD. */
+            amount: components['schemas']['Numeric'];
         };
         /** @description Limited representation of a feature resource which includes only its unique identifiers (id, key). */
         FeatureMeta: {
@@ -6097,6 +6272,11 @@ export interface components {
             /** @description The items in the current page. */
             items: components['schemas']['Feature'][];
         };
+        /**
+         * @description Per-unit cost configuration for a feature.
+         *     Either a fixed manual amount or a dynamic LLM cost lookup.
+         */
+        FeatureUnitCost: components['schemas']['FeatureManualUnitCost'] | components['schemas']['FeatureLLMUnitCost'];
         /** @description A filter for a ID (ULID) field allowing only equality or inclusion. */
         FilterIDExact: {
             /** @description The field must be in the provided list of values. */
@@ -6623,6 +6803,12 @@ export interface components {
              *     discounts that are affecting multiple lines.
              */
             readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
+            /**
+             * @description Credit allocations applied to this line.
+             *
+             *     Credits are deducted from the line total before taxes are applied.
+             */
+            readonly creditAllocations?: components['schemas']['InvoiceLineCreditAllocation'][];
             /** @description The invoice this item belongs to. */
             invoice?: components['schemas']['InvoiceReference'];
             /** @description The currency of this line. */
@@ -6803,6 +6989,12 @@ export interface components {
              *     discounts that are affecting multiple lines.
              */
             readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
+            /**
+             * @description Credit allocations applied to this line.
+             *
+             *     Credits are deducted from the line total before taxes are applied.
+             */
+            readonly creditAllocations?: components['schemas']['InvoiceLineCreditAllocation'][];
             /** @description The invoice this item belongs to. */
             invoice?: components['schemas']['InvoiceReference'];
             /** @description The currency of this line. */
@@ -6926,6 +7118,16 @@ export interface components {
             /** @description The external ID of the invoice in the tax app if available. */
             readonly tax?: string;
         };
+        /** @description InvoiceLineCreditAllocation represents a credit amount allocated to the line before taxes are applied. */
+        InvoiceLineCreditAllocation: {
+            /**
+             * Amount in the currency of the invoice
+             * @description Amount allocated from credits.
+             */
+            readonly amount: components['schemas']['Numeric'];
+            /** @description Text description as to why the credit was allocated. */
+            readonly description?: string;
+        };
         /** @description InvoiceLineDiscounts represents the discounts applied to the invoice line by type. */
         InvoiceLineDiscounts: {
             /**
@@ -7390,6 +7592,8 @@ export interface components {
             readonly chargesTotal: components['schemas']['Numeric'];
             /** @description The amount of value of the line that are due to discounts. */
             readonly discountsTotal: components['schemas']['Numeric'];
+            /** @description The amount of value of the line that are due to credits. */
+            readonly creditsTotal: components['schemas']['Numeric'];
             /** @description The total amount of taxes that are included in the line. */
             readonly taxesInclusiveTotal: components['schemas']['Numeric'];
             /** @description The total amount of taxes that are added on top of amount from the line. */
@@ -9180,6 +9384,16 @@ export interface components {
              *     - scheduled = now < effectiveFrom < effectiveTo
              */
             readonly status: components['schemas']['PlanStatus'];
+            /**
+             * Settlement mode
+             * @description The settlement mode of the plan.
+             *     It determines how the billing system generates invoices and credits for the subscriptions using this plan.
+             *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
+             *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+             *     This is the default and most common settlement mode.
+             * @default credit_then_invoice
+             */
+            settlementMode?: components['schemas']['BillingSettlementMode'];
             /**
              * Plan phases
              * @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
@@ -9364,6 +9578,16 @@ export interface components {
              *     }
              */
             proRatingConfig?: components['schemas']['ProRatingConfig'];
+            /**
+             * Settlement mode
+             * @description The settlement mode of the plan.
+             *     It determines how the billing system generates invoices and credits for the subscriptions using this plan.
+             *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
+             *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+             *     This is the default and most common settlement mode.
+             * @default credit_then_invoice
+             */
+            settlementMode?: components['schemas']['BillingSettlementMode'];
             /**
              * Plan phases
              * @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
@@ -9487,6 +9711,16 @@ export interface components {
              *     }
              */
             proRatingConfig?: components['schemas']['ProRatingConfig'];
+            /**
+             * Settlement mode
+             * @description The settlement mode of the plan.
+             *     It determines how the billing system generates invoices and credits for the subscriptions using this plan.
+             *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
+             *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+             *     This is the default and most common settlement mode.
+             * @default credit_then_invoice
+             */
+            settlementMode?: components['schemas']['BillingSettlementMode'];
             /**
              * Plan phases
              * @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
@@ -9567,6 +9801,8 @@ export interface components {
              * @example 2023-01-01T01:01:01.001Z
              */
             billingAnchor?: Date;
+            /** @description The settlement mode of the subscription. */
+            settlementMode?: components['schemas']['BillingSettlementMode'];
         };
         /**
          * @description A consumer portal token.
@@ -10653,6 +10889,15 @@ export interface components {
              * @example 2023-01-01T01:01:01.001Z
              */
             readonly billingAnchor: Date;
+            /**
+             * Settlement mode
+             * @description The settlement mode of the subscription.
+             *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
+             *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+             *     This is the default and most common settlement mode.
+             * @default credit_then_invoice
+             */
+            readonly settlementMode: components['schemas']['BillingSettlementMode'];
         };
         /** @description A subscription add-on, represents concrete instances of an add-on for a given subscription. */
         SubscriptionAddon: {
@@ -11104,6 +11349,15 @@ export interface components {
              * @example 2023-01-01T01:01:01.001Z
              */
             readonly billingAnchor: Date;
+            /**
+             * Settlement mode
+             * @description The settlement mode of the subscription.
+             *     - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
+             *     - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
+             *     This is the default and most common settlement mode.
+             * @default credit_then_invoice
+             */
+            readonly settlementMode: components['schemas']['BillingSettlementMode'];
             /** @description Alignment details enriched with the current billing period. */
             alignment?: components['schemas']['SubscriptionAlignment'];
             /** @description The phases of the subscription. */
@@ -11381,14 +11635,25 @@ export interface components {
             behavior?: components['schemas']['TaxBehavior'];
             /**
              * Stripe tax config
+             * @deprecated
              * @description Stripe tax config.
              */
             stripe?: components['schemas']['StripeTaxConfig'];
             /**
              * Custom invoicing tax config
+             * @deprecated
              * @description Custom invoicing tax config.
              */
             customInvoicing?: components['schemas']['CustomInvoicingTaxConfig'];
+            /**
+             * Tax code ID
+             * @description Tax code reference.
+             *
+             *     When both `taxCodeId` and `stripe.code` are provided, `taxCodeId` takes precedence:
+             *     the referenced tax code entity is used and `stripe.code` is ignored.
+             * @example 01G65Z755AFWAKHE12NY0CQ9FH
+             */
+            taxCodeId?: string;
         };
         /**
          * @description The mode of the tiered price.
@@ -12023,6 +12288,7 @@ export type BillingProfileExpand = components['schemas']['BillingProfileExpand']
 export type BillingProfileOrderBy = components['schemas']['BillingProfileOrderBy'];
 export type BillingProfilePaginatedResponse = components['schemas']['BillingProfilePaginatedResponse'];
 export type BillingProfileReplaceUpdateWithWorkflow = components['schemas']['BillingProfileReplaceUpdateWithWorkflow'];
+export type BillingSettlementMode = components['schemas']['BillingSettlementMode'];
 export type BillingTaxIdentificationCode = components['schemas']['BillingTaxIdentificationCode'];
 export type BillingWorkflow = components['schemas']['BillingWorkflow'];
 export type BillingWorkflowCollectionAlignment = components['schemas']['BillingWorkflowCollectionAlignment'];
@@ -12123,6 +12389,7 @@ export type EntitlementV2 = components['schemas']['EntitlementV2'];
 export type EntitlementV2CreateInputs = components['schemas']['EntitlementV2CreateInputs'];
 export type EntitlementV2PaginatedResponse = components['schemas']['EntitlementV2PaginatedResponse'];
 export type EntitlementValue = components['schemas']['EntitlementValue'];
+export type EntitlementValueV2 = components['schemas']['EntitlementValueV2'];
 export type ErrorExtension = components['schemas']['ErrorExtension'];
 export type Event = components['schemas']['Event'];
 export type EventDeliveryAttemptResponse = components['schemas']['EventDeliveryAttemptResponse'];
@@ -12130,9 +12397,13 @@ export type ExpirationDuration = components['schemas']['ExpirationDuration'];
 export type ExpirationPeriod = components['schemas']['ExpirationPeriod'];
 export type Feature = components['schemas']['Feature'];
 export type FeatureCreateInputs = components['schemas']['FeatureCreateInputs'];
+export type FeatureLlmUnitCost = components['schemas']['FeatureLLMUnitCost'];
+export type FeatureLlmUnitCostPricing = components['schemas']['FeatureLLMUnitCostPricing'];
+export type FeatureManualUnitCost = components['schemas']['FeatureManualUnitCost'];
 export type FeatureMeta = components['schemas']['FeatureMeta'];
 export type FeatureOrderBy = components['schemas']['FeatureOrderBy'];
 export type FeaturePaginatedResponse = components['schemas']['FeaturePaginatedResponse'];
+export type FeatureUnitCost = components['schemas']['FeatureUnitCost'];
 export type FilterIdExact = components['schemas']['FilterIDExact'];
 export type FilterString = components['schemas']['FilterString'];
 export type FilterTime = components['schemas']['FilterTime'];
@@ -12166,6 +12437,7 @@ export type InvoiceGenericDocumentRef = components['schemas']['InvoiceGenericDoc
 export type InvoiceLine = components['schemas']['InvoiceLine'];
 export type InvoiceLineAmountDiscount = components['schemas']['InvoiceLineAmountDiscount'];
 export type InvoiceLineAppExternalIds = components['schemas']['InvoiceLineAppExternalIds'];
+export type InvoiceLineCreditAllocation = components['schemas']['InvoiceLineCreditAllocation'];
 export type InvoiceLineDiscounts = components['schemas']['InvoiceLineDiscounts'];
 export type InvoiceLineManagedBy = components['schemas']['InvoiceLineManagedBy'];
 export type InvoiceLineReplaceUpdate = components['schemas']['InvoiceLineReplaceUpdate'];
@@ -18546,7 +18818,14 @@ export interface operations {
     };
     voidGrant: {
         parameters: {
-            query?: never;
+            query?: {
+                /**
+                 * @description The time at which the grant should be voided.
+                 *     Must not be in the future and must be within the current usage period of the entitlement.
+                 *     Defaults to the current time if not specified.
+                 */
+                at?: Date | string;
+            };
             header?: never;
             path: {
                 grantId: string;
@@ -20143,6 +20422,7 @@ export interface operations {
                 };
                 content: {
                     'application/json': components['schemas']['MeterQueryResult'];
+                    'text/csv': string;
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
@@ -27150,7 +27430,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['EntitlementValue'];
+                    'application/json': components['schemas']['EntitlementValueV2'];
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */

package/dist/cjs/src/client/subscriptions.d.cts

@@ -32,6 +32,7 @@ export declare class Subscriptions {
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
+        readonly settlementMode: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
     } | undefined>;
     /**
      * Get a subscription
@@ -57,6 +58,7 @@ export declare class Subscriptions {
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
+        readonly settlementMode: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
         alignment?: import("./schemas.cjs").components["schemas"]["SubscriptionAlignment"];
         phases: import("./schemas.cjs").components["schemas"]["SubscriptionPhaseExpanded"][];
     } | undefined>;
@@ -86,6 +88,7 @@ export declare class Subscriptions {
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
+        readonly settlementMode: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
     } | undefined>;
     /**
      * Cancel a subscription
@@ -113,6 +116,7 @@ export declare class Subscriptions {
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
+        readonly settlementMode: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
     } | undefined>;
     /**
      * Change a subscription
@@ -163,6 +167,7 @@ export declare class Subscriptions {
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
+        readonly settlementMode: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
     } | undefined>;
     /**
      * Delete subscription