@openmeter/sdk 1.0.0-beta.90 → 1.0.0-beta.91

package/dist/schemas/openapi.d.ts

@@ -122,6 +122,13 @@ export interface paths {
          */
         get: operations['queryPortalMeter'];
     };
+    '/api/v1/entitlements': {
+        /**
+         * List entitlements
+         * @description List entitlements.
+         */
+        get: operations['listEntitlements'];
+    };
     '/api/v1/features': {
         /**
          * List features
@@ -134,10 +141,10 @@ export interface paths {
          */
         post: operations['createFeature'];
     };
-    '/api/v1/features/{featureID}': {
+    '/api/v1/features/{featureId}': {
         /**
          * Get feature
-         * @description Get feature by key.
+         * @description Get feature by id.
          */
         get: operations['getFeature'];
         /**
@@ -146,75 +153,163 @@ export interface paths {
          */
         delete: operations['deleteFeature'];
     };
-    '/api/v1/ledgers': {
+    '/api/v1/grants': {
         /**
-         * List the already defined ledgers.
-         * @description List the already defined ledgers.
+         * List grants
+         * @description List all grants.
          */
-        get: operations['listLedgers'];
+        get: operations['listGrants'];
+    };
+    '/api/v1/grants/{grantId}': {
         /**
-         * Creates the specified ledger
-         * @description Create or update the specified ledger.
+         * Delete a grant
+         * @description Void (delete) a grant. A grant can only be deleted if it hasn't been used.
          */
-        post: operations['createLedger'];
+        delete: operations['voidGrant'];
     };
-    '/api/v1/ledgers/{ledgerID}/balance': {
+    '/api/v1/subjects/{subjectIdOrKey}/entitlements': {
         /**
-         * Get the balance of a specific subject.
-         * @description Get the balance of a specific subject.
+         * List entitlements
+         * @description List all entitlements for a subject.
          */
-        get: operations['getLedgerBalance'];
-    };
-    '/api/v1/ledgers/{ledgerID}/history': {
+        get: operations['listSubjectEntitlements'];
         /**
-         * Get the history of a ledger
-         * @description Get the history of a specific ledger
+         * Create entitlement
+         * @description Create an entitlement for a subject.
          */
-        get: operations['getLedgerHistory'];
+        post: operations['createEntitlement'];
     };
-    '/api/v1/ledgers/{ledgerID}/reset': {
+    '/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}': {
         /**
-         * Reset the ledger's balance
-         * @description Resets the ledger's balances to zero for a specific subject and re-apply active grants with rollover configuration.
+         * Get entitlement
+         * @description Get entitlement by id.
          */
-        post: operations['resetLedger'];
-    };
-    '/api/v1/ledgers/grants': {
+        get: operations['getEntitlement'];
         /**
-         * List grants for multiple ledgers.
-         * @description List grants for multiple ledgers.
+         * Delete entitlement
+         * @description Delete an entitlement by id.
          */
-        get: operations['listLedgerGrants'];
+        delete: operations['deleteEntitlement'];
     };
-    '/api/v1/ledgers/{ledgerID}/grants': {
+    '/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}/grants': {
         /**
-         * List ledger grants
-         * @description List ledger grants for a specific ledger.
+         * List grants for an entitlement
+         * @description List all grants for an entitlement.
          */
-        get: operations['listLedgerGrantsByLedger'];
+        get: operations['listEntitlementGrants'];
         /**
-         * Create a grant on a specific ledger.
-         * @description Create a grant on a specific ledger.
+         * Create grant
+         * @description Create a grant for an entitlement.
          */
-        post: operations['createLedgerGrant'];
+        post: operations['createGrant'];
     };
-    '/api/v1/ledgers/{ledgerID}/grants/{ledgerGrantID}': {
+    '/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value': {
         /**
-         * Get a single grant.
-         * @description Gets the grant for a ledger by ID.
+         * Get the balance of a specific entitlement.
+         * @description Get the balance of a specific entitlement.
          */
-        get: operations['getLedgerGrant'];
+        get: operations['getEntitlementValue'];
+    };
+    '/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}/history': {
         /**
-         * Void ledger grant
-         * @description Void a ledger grant by ID. Partially or fully used grants cannot be voided.
-         * Voided grant won't be applied to the subject's balance anymore.
+         * Get the balance history of a specific entitlement.
+         * @description Get the balance history of a specific entitlement.
+         *
+         * The windows are inclusive at their start and exclusive at their end.
+         * The last window may be smaller than the window size and is inclusive at both ends.
+         */
+        get: operations['getEntitlementHistory'];
+    };
+    '/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}/reset': {
+        /**
+         * Reset entitlement
+         * @description Reset the entitlement usage and start a new period. Grants that can be are rolled over.
          */
-        delete: operations['voidLedgerGrant'];
+        post: operations['resetEntitlementUsage'];
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * @description Metadata fields for a resource.
+         * These fields are automatically populated by the system for the entities we manage.
+         */
+        SharedMetaFields: {
+            /**
+             * @description Readonly unique ULID identifier.
+             *
+             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             */
+            id: string;
+            /**
+             * Format: date-time
+             * @description The date and time the resource was created.
+             * @example 2023-01-01T00:00:00Z
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description The date and time the resource was last updated.
+             * @example 2023-01-01T00:00:00Z
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description The date and time the resource was deleted.
+             * @example null
+             */
+            deletedAt: string | null;
+        };
+        /**
+         * @description Conflict
+         * @example {
+         *   "type": "about:blank",
+         *   "title": "Conflict",
+         *   "status": 409,
+         *   "detail": "ledger (default.01HXVNDJR532E8GTBVSC2XK5D4) already exitst for subject subject-1",
+         *   "instance": "urn:request:local/JMOlctsKV8-000001",
+         *   "conflictingEntityId": "01HXVNDJR532E8GTBVSC2XK5D4"
+         * }
+         */
+        ConflictProblem: {
+            /**
+             * Format: uri
+             * @description Type contains a URI that identifies the problem type.
+             * @example urn:problem-type:bad-request
+             */
+            type: string;
+            /**
+             * @description A a short, human-readable summary of the problem type.
+             * @example Bad Request
+             */
+            title: string;
+            /**
+             * Format: int32
+             * @description The HTTP status code generated by the origin server for this occurrence of the problem.
+             * @example 400
+             */
+            status: number;
+            /**
+             * @description A human-readable explanation specific to this occurrence of the problem.
+             * @example body must be a JSON object
+             */
+            detail: string;
+            /**
+             * Format: uri
+             * @description A URI reference that identifies the specific occurrence of the problem.
+             * @example urn:request:local/JMOlctsKV8-000001
+             */
+            instance?: string;
+            extensions?: {
+                /**
+                 * @description The id of the conflicting entity.
+                 * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+                 */
+                conflictingEntityId: string;
+            };
+            [key: string]: unknown;
+        };
         /**
          * @description A Problem Details object (RFC 7807).
          * Additional properties specific to the problem type may be present.
@@ -354,19 +449,30 @@ export interface components {
          * @description A feature is a feature or service offered to a customer.
          * For example: CPU-Hours, Tokens, API Calls, etc.
          */
-        CreateFeatureRequest: {
+        FeatureCreateInputs: {
+            /**
+             * @description The unique key of the feature to reference it from your application.
+             *
+             * @example gpt4_tokens
+             */
+            key: string;
             /**
              * @description The name of the feature.
              *
              * @example AI Tokens
              */
             name: string;
+            /** @description Additional metadata for the feature. */
+            metadata?: {
+                [key: string]: string;
+            };
             /**
              * @description The meter that the feature is associated with and decreases grants by usage.
+             * If present, the usage of the feature can be metered.
              *
              * @example tokens_total
              */
-            meterSlug: string;
+            meterSlug?: string;
             /**
              * @description Optional meter group by filters. Useful if the meter scope is broader than what feature tracks.
              *
@@ -377,256 +483,239 @@ export interface components {
             meterGroupByFilters?: {
                 [key: string]: string;
             };
-            /**
-             * @description If the feature is archived, it will not be used for grants or usage.
-             *
-             * @example false
-             */
-            archived?: boolean;
         };
         /**
          * @description A feature is a feature or service offered to a customer.
          * For example: CPU-Hours, Tokens, API Calls, etc.
          */
-        Feature: components['schemas']['CreateFeatureRequest'] & {
-            /**
-             * @description Readonly unique ULID identifier of the feature.
-             *
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
-             */
-            id: string;
+        Feature: {
             /**
              * Format: date-time
-             * @description The time the feature was created.
+             * @description If the feature is archived, it will not be used for grants or usage.
              *
              * @example 2023-01-01T00:00:00Z
              */
-            createdAt?: string;
+            archivedAt?: string;
+        } & components['schemas']['FeatureCreateInputs'] & components['schemas']['SharedMetaFields'];
+        EntitlementCreateSharedFields: {
             /**
-             * Format: date-time
-             * @description The time the feature was last updated.
+             * @description The feature the subject is entitled to use
              *
-             * @example 2023-01-01T00:00:00Z
-             */
-            updatedAt?: string;
-        };
-        /**
-         * @description A ledger represented in open meter. A ledger must be assigned to a single
-         * subject.
-         */
-        CreateLedger: {
-            /** @description The metering subject this ledger used to track grants for. */
-            subject: string;
-            /**
-             * @example {
-             *   "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
-             * }
+             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
              */
+            featureId: string;
+            /** @description Additional metadata for the feature. */
             metadata?: {
                 [key: string]: string;
             };
+            usagePeriod?: components['schemas']['RecurringPeriod'];
         };
-        /**
-         * @description Ledger Exists
-         * @example {
-         *   "type": "about:blank",
-         *   "title": "Conflict",
-         *   "status": 409,
-         *   "detail": "ledger (default.01HXVNDJR532E8GTBVSC2XK5D4) already exitst for subject subject-1",
-         *   "instance": "urn:request:local/JMOlctsKV8-000001",
-         *   "conflictingEntity": {
-         *     "id": "01HXVNDJR532E8GTBVSC2XK5D4",
-         *     "subject": "subject-1"
-         *   }
-         * }
-         */
-        LedgerAlreadyExistsProblem: {
+        EntitlementSharedFields: components['schemas']['SharedMetaFields'] & components['schemas']['EntitlementCreateSharedFields'] & {
             /**
-             * Format: uri
-             * @description Type contains a URI that identifies the problem type.
-             * @example urn:problem-type:bad-request
-             */
-            type: string;
-            /**
-             * @description A a short, human-readable summary of the problem type.
-             * @example Bad Request
-             */
-            title: string;
-            /**
-             * Format: int32
-             * @description The HTTP status code generated by the origin server for this occurrence of the problem.
-             * @example 400
+             * @description The identifier key unique to the subject
+             * @example customer-1
              */
-            status: number;
+            subjectKey: string;
+            usagePeriod?: components['schemas']['RecurringPeriod'];
+        };
+        EntitlementMeteredCreateInputs: components['schemas']['EntitlementCreateSharedFields'] & {
             /**
-             * @description A human-readable explanation specific to this occurrence of the problem.
-             * @example body must be a JSON object
+             * @example metered
+             * @enum {string}
              */
-            detail: string;
+            type: 'metered';
             /**
-             * Format: uri
-             * @description A URI reference that identifies the specific occurrence of the problem.
-             * @example urn:request:local/JMOlctsKV8-000001
+             * @description If unlimited=true the subject can use the feature an unlimited amount.
+             *
+             * @default false
              */
-            instance?: string;
-            conflictingEntity?: components['schemas']['Ledger'];
-            [key: string]: unknown;
+            isUnlimited?: boolean;
+            usagePeriod: components['schemas']['RecurringPeriod'];
+            /** @description You can issue usage automatically after reset. This usage is not rolled over. */
+            issueAfterReset?: number;
         };
-        /** @description A ledger represented in our system. */
-        Ledger: components['schemas']['CreateLedger'] & {
+        /** @description Entitles a subject to use a feature. */
+        EntitlementMetered: components['schemas']['EntitlementMeteredCreateInputs'] & components['schemas']['EntitlementSharedFields'];
+        EntitlementStaticCreateInputs: components['schemas']['EntitlementCreateSharedFields'] & {
             /**
-             * @description Readonly unique ULID identifier of the ledger.
-             *
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             * @example static
+             * @enum {string}
              */
-            id: string;
+            type: 'static';
             /**
-             * Format: date-time
-             * @description The time the ledger was created.
+             * @description The JSON parsable config of the entitlement.
              *
-             * @example 2023-01-01T00:00:00Z
+             * @example {"key1": "value1"}
              */
-            createdAt?: string;
+            config: string;
         };
-        /** @description A ledger entry. */
-        LedgerEntry: {
-            /**
-             * @description Readonly unique ULID identifier of the ledger entry.
-             *
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
-             */
-            id: string;
-            type: components['schemas']['LedgerEntryType'];
+        /** @description Entitles a subject to use a feature. */
+        EntitlementStatic: components['schemas']['EntitlementStaticCreateInputs'] & components['schemas']['EntitlementSharedFields'];
+        EntitlementBooleanCreateInputs: components['schemas']['EntitlementCreateSharedFields'] & {
             /**
-             * Format: date-time
-             * @description The time the ledger entry was created.
-             *
-             * @example 2023-01-01T00:00:00Z
+             * @example boolean
+             * @enum {string}
              */
-            time: string;
+            type: 'boolean';
+        };
+        /** @description Entitles a subject to use a feature. */
+        EntitlementBoolean: components['schemas']['EntitlementBooleanCreateInputs'] & components['schemas']['EntitlementSharedFields'];
+        Entitlement: components['schemas']['EntitlementMetered'] | components['schemas']['EntitlementStatic'] | components['schemas']['EntitlementBoolean'];
+        /**
+         * @description A segment of the grant burn down history.
+         *
+         * A given segment represents the usage of a grant in a specific period.
+         */
+        GrantBurnDownHistorySegment: {
+            period?: components['schemas']['Period'];
             /**
              * Format: double
-             * @description The amount to apply. Can be positive or negative number. If applicable.
+             * @description The usage of the grant in the period.
              *
              * @example 100
              */
-            amount: number;
+            usage?: number;
             /**
-             * @description The unique feature ULID that the entry is associated with.
+             * Format: double
+             * @description Overuse that wasn't covered by grants.
              *
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             * @example 25
              */
-            featureID: string;
-            period?: components['schemas']['Period'];
-        };
-        /** @description A time period */
-        Period: {
+            overage?: number;
             /**
-             * Format: date-time
-             * @description Period start time where the amount was applied. If applicable.
+             * Format: double
+             * @description The entitlement balance at the start of the period.
              *
-             * @example 2023-01-01T00:00:00Z
+             * @example 100
              */
-            from: string;
+            balanceAtStart?: number;
             /**
-             * Format: date-time
-             * @description Period end time where the amount was applied. If applicable.
+             * @description The balance breakdown of each active grant at the start of the period: GrantID: Balance
              *
-             * @example 2023-01-01T00:00:00Z
-             */
-            to: string;
-        };
-        /**
-         * @example GRANT
-         * @enum {string}
-         */
-        LedgerEntryType: 'GRANT' | 'VOID' | 'RESET' | 'GRANT_USAGE';
-        /** @description Balance of a subject. */
-        LedgerBalance: {
-            /** @description Features with balances. */
-            featureBalances: components['schemas']['FeatureBalance'][];
-            /** @description The grants applied to the subject. */
-            grantBalances: components['schemas']['LedgerGrantBalance'][];
-            /**
              * @example {
-             *   "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
+             *   "01ARZ3NDEKTSV4RRFFQ69G5FAV": 100
              * }
              */
-            metadata?: {
-                [key: string]: string;
+            grantBalancesAtStart?: {
+                [key: string]: number;
             };
             /**
-             * @description The subject of the ledger.
+             * Format: double
+             * @description The entitlement balance at the end of the period.
              *
-             * @example subject-1
+             * @example 100
              */
-            subject: string;
+            balanceAtEnd?: number;
             /**
-             * Format: date-time
-             * @description The last reset of the ledger.
+             * @description The balance breakdown of each active grant at the start of the period: GrantID: Balance
              *
-             * @example 2023-01-01T00:00:00Z
+             * @example {
+             *   "01ARZ3NDEKTSV4RRFFQ69G5FAV": 100
+             * }
              */
-            lastReset?: string;
+            grantBalancesAtEnd?: {
+                [key: string]: number;
+            };
+            /** @description Which grants were actually burnt down in the period and by what amount. */
+            grantUsages?: readonly components['schemas']['GrantUsageRecord'][];
         };
-        /** @description Ledger reset configuration. */
-        LedgerReset: {
+        GrantUsageRecord: {
             /**
-             * @description Readonly unique ULID identifier of the reset.
+             * @description The id of the grant.
              *
              * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
              */
-            id: string;
+            grantId?: string;
             /**
-             * Format: date-time
-             * @description The time to reset the ledger. It cannot be in the future.
-             * The value will be floored to metering windowSize (minute).
+             * Format: double
+             * @description The usage of the grant.
              *
-             * @example 2023-01-01T00:00:00Z
+             * @example 100
              */
-            effectiveAt: string;
+            usage?: number;
         };
-        LedgerGrantBalance: components['schemas']['LedgerGrantResponse'] & {
+        /** @description A window of balance history. */
+        BalanceHistoryWindow: {
+            period?: components['schemas']['Period'];
             /**
              * Format: double
-             * @description The balance of the grant.
+             * @description The total usage of the feature in the period.
              *
              * @example 100
              */
-            balance: number;
-        };
-        FeatureBalance: components['schemas']['Feature'] & {
+            usage?: number;
             /**
              * Format: double
-             * @description The balance of the feature.
+             * @description The entitlement balance at the start of the period.
              *
              * @example 100
              */
-            balance: number;
+            balanceAtStart?: number;
+        };
+        /** @description The windowed balance history. */
+        WindowedBalanceHistory: {
             /**
-             * Format: double
-             * @description The usage of the feature.
+             * @description The windowed balance history.
+             * Only returns rows for windows where there was usage.
+             */
+            windowedHistory?: components['schemas']['BalanceHistoryWindow'][];
+            /** @description The grant burn down history in the period. */
+            burndownHistory?: components['schemas']['GrantBurnDownHistorySegment'][];
+        };
+        /** @description A time period */
+        Period: {
+            /**
+             * Format: date-time
+             * @description Period start time where the amount was applied. If applicable.
              *
-             * @example 100
+             * @example 2023-01-01T00:00:00Z
+             */
+            from: string;
+            /**
+             * Format: date-time
+             * @description Period end time where the amount was applied. If applicable.
+             *
+             * @example 2023-01-01T00:00:00Z
+             */
+            to: string;
+        };
+        /**
+         * @description List of pre-defined periods that can be used for recurring & scheduling.
+         *
+         * DAILY:      Every day
+         * # MONDAY:     Every Monday
+         * # TUESDAY:    Every Tuesday
+         * # WEDNESDAY:  Every Wednesday
+         * # THURSDAY:   Every Thursday
+         * # FRIDAY:     Every Friday
+         * # SATURDAY:   Every Saturday
+         * # SUNDAY:     Every Sunday
+         * WEEKLY:     Every week
+         * MONTHLY:    Every month
+         * YEARLY:     Every year
+         * BILLING:    Every billing cycle
+         *
+         * @enum {string}
+         */
+        RecurringPeriodEnum: 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' | 'BILLING';
+        /** @description Recurring period of an entitlement. */
+        RecurringPeriod: {
+            interval: components['schemas']['RecurringPeriodEnum'];
+            /**
+             * Format: date-time
+             * @description An arbitrary anchor to base the recurring period on.
              */
-            usage: number;
+            anchor: string;
         };
         /** @description Grants are used to increase balance of specific subjects. */
-        CreateLedgerGrantRequest: {
-            type: components['schemas']['LedgerGrantType'];
+        EntitlementGrantCreateInput: {
             /**
              * Format: double
-             * @description The amount to grant. Can be positive or negative number.
+             * @description The amount to grant. Should be a positive number.
              *
              * @example 100
              */
             amount: number;
-            /**
-             * @description The unique feature ULID that the grant is associated with, if any.
-             *
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
-             */
-            featureID: string;
             /**
              * @description The priority of the grant. Grants with higher priority are applied first.
              * Priority is a positive decimal numbers. With lower numbers indicating higher importance.
@@ -646,8 +735,21 @@ export interface components {
              * @example 2023-01-01T00:00:00Z
              */
             effectiveAt: string;
-            expiration: components['schemas']['LedgerGrantExpirationPeriod'];
-            rollover?: components['schemas']['LedgerGrantRollover'];
+            expiration: components['schemas']['ExpirationPeriod'];
+            /**
+             * Format: double
+             * @description The maximum amount of the grant that can be rolled over. Defaults to 0.
+             *
+             * - maxAmount = {original_amount} -> rollover original amount
+             * - maxAmount = 0 -> no rollover
+             * - maxAmount = 90 -> rollover 90 max
+             *
+             * If it's larger than 0 then the grant's balance will be the MAX(maxRollover, balance) + amount.
+             *
+             * @default 0
+             * @example 100
+             */
+            maxRolloverAmount?: number;
             /**
              * @example {
              *   "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
@@ -656,78 +758,73 @@ export interface components {
             metadata?: {
                 [key: string]: string;
             };
+            recurrence?: components['schemas']['RecurringPeriod'];
+        };
+        EntitlementGrant: components['schemas']['EntitlementGrantCreateInput'] & components['schemas']['SharedMetaFields'] & {
             /**
-             * @description The parent grant ULID that the grant is associated with, if any.
+             * @description The unique entitlement ULID that the grant is associated with.
              *
              * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
              */
-            parentId?: string;
+            entitlementId: string;
+            /**
+             * @description The subject that is granted the entitlement.
+             *
+             * @example customer-id
+             */
+            subjectKey: string;
             /**
              * Format: date-time
-             * @description The time the grant was created.
+             * @description The next time the grant will recurr.
              *
              * @example 2023-01-01T00:00:00Z
              */
-            createdAt?: string;
+            nextRecurrence?: string;
             /**
              * Format: date-time
-             * @description The time the grant was last updated.
+             * @description The expiration date of the grant.
              *
              * @example 2023-01-01T00:00:00Z
              */
-            updatedAt?: string;
+            expiresAt?: string;
+            /**
+             * Format: date-time
+             * @description The date and time the grant was voided (cannot be used after that).
+             */
+            voidedAt?: string;
         };
-        LedgerGrantResponse: components['schemas']['CreateLedgerGrantRequest'] & {
+        EntitlementValue: {
             /**
-             * @description Readonly unique ULID identifier of the grant.
-             *
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             * @description Whether the subject has access to the feature.
+             * @example true
              */
-            id: string;
+            hasAccess: boolean;
             /**
-             * @description The ledger ID.
-             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             * Format: double
+             * @description The balance of a metered entitlement.
+             * @example 100
              */
-            ledgerID: string;
+            balance?: number;
             /**
-             * @description If the grant is voided, it will not be applied to the subject's balance anymore.
-             *
-             * @example false
+             * Format: double
+             * @description Total usage of the feature in the period. Includes overages.
+             * @example 50
              */
-            void: boolean;
+            usage?: number;
             /**
-             * Format: date-time
-             * @description The expiration date of the grant.
-             *
-             * @example 2023-01-01T00:00:00Z
+             * Format: double
+             * @description The overage of a metered entitlement.
+             * @example 0
              */
-            expiresAt?: string;
-        };
-        /**
-         * @description The grant type:
-         * - `USAGE` - Increase balance by the amount in the unit of the associated meter.
-         *
-         * @example USAGE
-         * @enum {string}
-         */
-        LedgerGrantType: 'USAGE';
-        /** @description Grant rollover configuration. */
-        LedgerGrantRollover: {
-            type: components['schemas']['LedgerGrantRolloverType'];
-            /** @description Maximum amount to rollover. */
-            maxAmount?: number;
+            overage?: number;
+            /**
+             * @description The JSON parseable configuration value of a static entitlement.
+             * @example {"key1": "value1"}
+             */
+            config?: string;
         };
-        /**
-         * @description The rollover type to use:
-         * - `REMAINING_AMOUNT` - Rollover remaining amount.
-         * - `ORIGINAL_AMOUNT` - Rollover re-applies the full grant amount.
-         *
-         * @example ORIGINAL_AMOUNT
-         * @enum {string}
-         */
-        LedgerGrantRolloverType: 'REMAINING_AMOUNT' | 'ORIGINAL_AMOUNT';
-        /** @description Expiration period of a ledger grant. */
-        LedgerGrantExpirationPeriod: {
+        /** @description Expiration period of a grant. */
+        ExpirationPeriod: {
             /**
              * @description The expiration period duration like month.
              *
@@ -991,6 +1088,12 @@ export interface components {
         IdOrSlug: string;
     };
     responses: {
+        /** @description Ledger Exists */
+        ConflictProblemResponse: {
+            content: {
+                'application/problem+json': components['schemas']['ConflictProblem'];
+            };
+        };
         /** @description Bad Request */
         BadRequestProblemResponse: {
             content: {
@@ -1003,12 +1106,6 @@ export interface components {
                 'application/problem+json': components['schemas']['Problem'];
             };
         };
-        /** @description Ledger Exists */
-        LedgerAlreadyExistsProblemResponse: {
-            content: {
-                'application/problem+json': components['schemas']['LedgerAlreadyExistsProblem'];
-            };
-        };
         /** @description Not Found */
         NotFoundProblemResponse: {
             content: {
@@ -1034,17 +1131,19 @@ export interface components {
         /** @description A unique identifier for a subject. */
         subjectIdOrKey: string;
         /** @description A unique ULID identifier for a feature. */
-        featureID: string;
-        /** @description A unique identifier for a ledger grant. */
-        ledgerGrantID: string;
-        /** @description A unique identifier for a ledger. */
-        ledgerID: string;
-        /** @description Include void entries in the response. */
-        ledgerIncludeVoids?: boolean;
+        featureId: string;
+        /** @description A unique identifier for a grant. */
+        grantId: string;
+        /** @description A unique ULID for an entitlement. */
+        entitlementId: string;
+        /** @description The id of the entitlement or the key of the feature. */
+        entitlementIdOrFeatureKey: string;
+        /** @description Include deleted entries. */
+        includeDeleted?: boolean;
         /** @description Number of entries to return */
-        ledgerQueryLimit?: number;
+        queryLimit?: number;
         /** @description Number of entries to skip */
-        ledgerQueryOffset?: number;
+        queryOffset?: number;
         /**
          * @description Start date-time in RFC 3339 format.
          * Inclusive.
@@ -1062,14 +1161,6 @@ export interface components {
          * If not specified, the UTC timezone will be used.
          */
         queryWindowTimeZone?: string;
-        /**
-         * @description Filtering and group by multiple subjects.
-         *
-         * Usage: `?ledgerID=01HX6VK5C498B3ABY9PR1069PP`
-         *
-         * @example 01HX6VK5C498B3ABY9PR1069PP
-         */
-        queryFilterLedgerID?: string;
         /**
          * @description Filtering by multiple subjects.
          *
@@ -1494,6 +1585,30 @@ export interface operations {
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
+    /**
+     * List entitlements
+     * @description List entitlements.
+     */
+    listEntitlements: {
+        parameters: {
+            query?: {
+                limit?: components['parameters']['queryLimit'];
+                offset?: components['parameters']['queryOffset'];
+                /** @description Order by field */
+                orderBy?: 'createdAt' | 'updatedAt';
+            };
+        };
+        responses: {
+            /** @description List of entitlements. */
+            200: {
+                content: {
+                    'application/json': components['schemas']['Entitlement'][];
+                };
+            };
+            401: components['responses']['UnauthorizedProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
     /**
      * List features
      * @description List features.
@@ -1501,8 +1616,8 @@ export interface operations {
     listFeatures: {
         parameters: {
             query?: {
-                limit?: components['parameters']['ledgerQueryLimit'];
-                offset?: components['parameters']['ledgerQueryOffset'];
+                limit?: components['parameters']['queryLimit'];
+                offset?: components['parameters']['queryOffset'];
                 /** @description Order by field */
                 orderBy?: 'id' | 'createdAt' | 'updatedAt';
                 /** @description Include archived features. */
@@ -1528,7 +1643,7 @@ export interface operations {
         /** @description The feature to create. */
         requestBody: {
             content: {
-                'application/json': components['schemas']['CreateFeatureRequest'];
+                'application/json': components['schemas']['FeatureCreateInputs'];
             };
         };
         responses: {
@@ -1546,12 +1661,12 @@ export interface operations {
     };
     /**
      * Get feature
-     * @description Get feature by key.
+     * @description Get feature by id.
      */
     getFeature: {
         parameters: {
             path: {
-                featureID: components['parameters']['featureID'];
+                featureId: components['parameters']['featureId'];
             };
         };
         responses: {
@@ -1573,7 +1688,7 @@ export interface operations {
     deleteFeature: {
         parameters: {
             path: {
-                featureID: components['parameters']['featureID'];
+                featureId: components['parameters']['featureId'];
             };
         };
         responses: {
@@ -1587,261 +1702,318 @@ export interface operations {
         };
     };
     /**
-     * List the already defined ledgers.
-     * @description List the already defined ledgers.
+     * List grants
+     * @description List all grants.
      */
-    listLedgers: {
+    listGrants: {
         parameters: {
             query?: {
-                /** @description Query ledgers specific to subjects. */
-                subject?: string[];
-                /** @description Query ledgers with subjects that are similar to the provided text. */
-                subjectSimilarTo?: string;
-                limit?: components['parameters']['ledgerQueryLimit'];
-                offset?: components['parameters']['ledgerQueryOffset'];
+                limit?: components['parameters']['queryLimit'];
+                offset?: components['parameters']['queryOffset'];
                 /** @description Order by field */
-                orderBy?: 'subject' | 'createdAt' | 'id';
+                orderBy?: 'id' | 'createdAt' | 'updatedAt';
+                includeDeleted?: components['parameters']['includeDeleted'];
             };
         };
         responses: {
-            /** @description List of the matching ledgers. */
+            /** @description List of grants. */
             200: {
                 content: {
-                    'application/json': components['schemas']['Ledger'][];
+                    'application/json': components['schemas']['EntitlementGrant'][];
                 };
             };
-            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Creates the specified ledger
-     * @description Create or update the specified ledger.
+     * Delete a grant
+     * @description Void (delete) a grant. A grant can only be deleted if it hasn't been used.
      */
-    createLedger: {
-        /** @description The ledger to be created */
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['CreateLedger'];
+    voidGrant: {
+        parameters: {
+            path: {
+                grantId: components['parameters']['grantId'];
             };
         };
         responses: {
-            /** @description The created ledger. */
-            201: {
-                content: {
-                    'application/json': components['schemas']['Ledger'];
-                };
+            /** @description Grant has been voided. */
+            204: {
+                content: never;
             };
             400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
-            409: components['responses']['LedgerAlreadyExistsProblemResponse'];
+            404: components['responses']['NotFoundProblemResponse'];
+            409: components['responses']['ConflictProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Get the balance of a specific subject.
-     * @description Get the balance of a specific subject.
+     * List entitlements
+     * @description List all entitlements for a subject.
      */
-    getLedgerBalance: {
+    listSubjectEntitlements: {
         parameters: {
             query?: {
-                /** @description Point of time to query balances: date-time in RFC 3339 format. Defaults to now. */
-                time?: string;
+                includeDeleted?: components['parameters']['includeDeleted'];
             };
             path: {
-                ledgerID: components['parameters']['ledgerID'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
             };
         };
         responses: {
-            /** @description Ledger balances available. */
+            /** @description List of entitlements. */
             200: {
                 content: {
-                    'application/json': components['schemas']['LedgerBalance'];
+                    'application/json': components['schemas']['Entitlement'][];
                 };
             };
             401: components['responses']['UnauthorizedProblemResponse'];
-            404: components['responses']['NotFoundProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Get the history of a ledger
-     * @description Get the history of a specific ledger
+     * Create entitlement
+     * @description Create an entitlement for a subject.
      */
-    getLedgerHistory: {
+    createEntitlement: {
         parameters: {
-            query: {
-                limit?: components['parameters']['ledgerQueryLimit'];
-                offset?: components['parameters']['ledgerQueryOffset'];
-                /** @description Start of time range to query ledger: date-time in RFC 3339 format. */
-                from: string;
-                /** @description End of time range to query ledger: date-time in RFC 3339 format. Defaults to now. */
-                to?: string;
-            };
             path: {
-                ledgerID: components['parameters']['ledgerID'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+            };
+        };
+        /** @description The entitlement to create. */
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['EntitlementMeteredCreateInputs'] | components['schemas']['EntitlementStaticCreateInputs'] | components['schemas']['EntitlementBooleanCreateInputs'];
             };
         };
         responses: {
-            /** @description Ledger balance history. */
-            200: {
+            /** @description Entitlement created. */
+            201: {
                 content: {
-                    'application/json': components['schemas']['LedgerEntry'][];
+                    'application/json': components['schemas']['Entitlement'];
                 };
             };
+            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
-            404: components['responses']['NotFoundProblemResponse'];
+            409: components['responses']['ConflictProblemResponse'];
+            501: components['responses']['NotImplementedProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Reset the ledger's balance
-     * @description Resets the ledger's balances to zero for a specific subject and re-apply active grants with rollover configuration.
+     * Get entitlement
+     * @description Get entitlement by id.
      */
-    resetLedger: {
+    getEntitlement: {
         parameters: {
             path: {
-                ledgerID: components['parameters']['ledgerID'];
-            };
-        };
-        /** @description Details for the reset. */
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['LedgerReset'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementId: components['parameters']['entitlementId'];
             };
         };
         responses: {
-            /** @description Ledger balance reset. */
-            201: {
+            /** @description Entitlement found. */
+            200: {
                 content: {
-                    'application/json': components['schemas']['LedgerReset'];
+                    'application/json': {
+                        type: 'json';
+                    } & Omit<components['schemas']['Entitlement'], 'type'> & {
+                        /**
+                         * Format: date-time
+                         * @description The last time usage was reset.
+                         * @example 2023-01-01T00:00:00Z
+                         */
+                        lastReset?: string;
+                    };
                 };
             };
-            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
             404: components['responses']['NotFoundProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * List grants for multiple ledgers.
-     * @description List grants for multiple ledgers.
+     * Delete entitlement
+     * @description Delete an entitlement by id.
      */
-    listLedgerGrants: {
+    deleteEntitlement: {
         parameters: {
-            query?: {
-                ledgerID?: components['parameters']['queryFilterLedgerID'];
-                limit?: components['parameters']['ledgerQueryLimit'];
-                includeVoids?: components['parameters']['ledgerIncludeVoids'];
+            path: {
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementId: components['parameters']['entitlementId'];
             };
         };
         responses: {
-            /** @description List of ledger grants. */
-            200: {
-                content: {
-                    'application/json': components['schemas']['LedgerGrantResponse'][];
-                };
+            /** @description Entitlement deleted. */
+            204: {
+                content: never;
             };
-            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
+            404: components['responses']['NotFoundProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * List ledger grants
-     * @description List ledger grants for a specific ledger.
+     * List grants for an entitlement
+     * @description List all grants for an entitlement.
      */
-    listLedgerGrantsByLedger: {
+    listEntitlementGrants: {
         parameters: {
             query?: {
-                limit?: components['parameters']['ledgerQueryLimit'];
-                includeVoids?: components['parameters']['ledgerIncludeVoids'];
+                includeDeleted?: components['parameters']['includeDeleted'];
+                /** @description Order by field */
+                orderBy?: 'id' | 'createdAt' | 'updatedAt';
             };
             path: {
-                ledgerID: components['parameters']['ledgerID'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementId: components['parameters']['entitlementId'];
             };
         };
         responses: {
-            /** @description List of ledger grants created. */
+            /** @description List of grants. */
             200: {
                 content: {
-                    'application/json': components['schemas']['LedgerGrantResponse'][];
+                    'application/json': components['schemas']['EntitlementGrant'][];
                 };
             };
-            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Create a grant on a specific ledger.
-     * @description Create a grant on a specific ledger.
+     * Create grant
+     * @description Create a grant for an entitlement.
      */
-    createLedgerGrant: {
+    createGrant: {
         parameters: {
             path: {
-                ledgerID: components['parameters']['ledgerID'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementId: components['parameters']['entitlementId'];
             };
         };
         /** @description The grant to create. */
         requestBody: {
             content: {
-                'application/json': components['schemas']['CreateLedgerGrantRequest'];
+                'application/json': components['schemas']['EntitlementGrantCreateInput'];
             };
         };
         responses: {
-            /** @description LedgerGrant created. */
+            /** @description Grant created. */
             201: {
                 content: {
-                    'application/json': components['schemas']['LedgerGrantResponse'];
+                    'application/json': components['schemas']['EntitlementGrant'];
                 };
             };
             400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
+            501: components['responses']['NotImplementedProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Get a single grant.
-     * @description Gets the grant for a ledger by ID.
+     * Get the balance of a specific entitlement.
+     * @description Get the balance of a specific entitlement.
      */
-    getLedgerGrant: {
+    getEntitlementValue: {
         parameters: {
+            query?: {
+                /** @description Point of time to check value: date-time in RFC 3339 format. Defaults to now. */
+                time?: string;
+            };
             path: {
-                ledgerID: components['parameters']['ledgerID'];
-                ledgerGrantID: components['parameters']['ledgerGrantID'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementIdOrFeatureKey: components['parameters']['entitlementIdOrFeatureKey'];
             };
         };
         responses: {
-            /** @description Ledger grant found. */
+            /** @description The entitlement value. */
             200: {
                 content: {
-                    'application/json': components['schemas']['LedgerGrantResponse'];
+                    'application/json': components['schemas']['EntitlementValue'];
                 };
             };
+            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
             404: components['responses']['NotFoundProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /**
-     * Void ledger grant
-     * @description Void a ledger grant by ID. Partially or fully used grants cannot be voided.
-     * Voided grant won't be applied to the subject's balance anymore.
+     * Get the balance history of a specific entitlement.
+     * @description Get the balance history of a specific entitlement.
+     *
+     * The windows are inclusive at their start and exclusive at their end.
+     * The last window may be smaller than the window size and is inclusive at both ends.
      */
-    voidLedgerGrant: {
+    getEntitlementHistory: {
         parameters: {
+            query: {
+                /**
+                 * @description Start of time range to query entitlement: date-time in RFC 3339 format.
+                 * Gets truncated to the granularity of the underlying meter.
+                 */
+                from: string;
+                /**
+                 * @description End of time range to query entitlement: date-time in RFC 3339 format. Defaults to now.
+                 * If not now then gets truncated to the granularity of the underlying meter.
+                 */
+                to?: string;
+                /** @description Size of the time window to group the history by. Cannot be shorter than meter granularity. */
+                windowSize: 'MINUTE' | 'HOUR' | 'DAY';
+                windowTimeZone?: components['parameters']['queryWindowTimeZone'];
+            };
             path: {
-                ledgerGrantID: components['parameters']['ledgerGrantID'];
-                ledgerID: components['parameters']['ledgerID'];
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementId: components['parameters']['entitlementId'];
             };
         };
         responses: {
-            /** @description Ledger grant voided. */
+            /** @description Entitlement balance history. If windowsize is specified then the history is grouped by the window size. */
+            200: {
+                content: {
+                    'application/json': components['schemas']['WindowedBalanceHistory'];
+                };
+            };
+            400: components['responses']['BadRequestProblemResponse'];
+            401: components['responses']['UnauthorizedProblemResponse'];
+            404: components['responses']['NotFoundProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
+        };
+    };
+    /**
+     * Reset entitlement
+     * @description Reset the entitlement usage and start a new period. Grants that can be are rolled over.
+     */
+    resetEntitlementUsage: {
+        parameters: {
+            path: {
+                subjectIdOrKey: components['parameters']['subjectIdOrKey'];
+                entitlementId: components['parameters']['entitlementId'];
+            };
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    /**
+                     * Format: date-time
+                     * @description The time at which the reset takes effect, defaults to now.
+                     * The reset cannot be in the future.
+                     * The provided value is truncated to the granularity of the underlying meter.
+                     *
+                     * @example 2023-01-01T00:00:00Z
+                     */
+                    effectiveAt?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Entitlement reset. */
             204: {
                 content: never;
             };
+            400: components['responses']['BadRequestProblemResponse'];
             401: components['responses']['UnauthorizedProblemResponse'];
             404: components['responses']['NotFoundProblemResponse'];
             default: components['responses']['UnexpectedProblemResponse'];