@openmeter/client 1.0.0-beta-89ad46498d71 → 1.0.0-beta-2b50cff9e992

package/README.md

@@ -36,6 +36,7 @@ TypeSpec definitions and ships fully-typed request and response models.
   - [Defaults](#defaults)
 - [Internal Operations](#internal-operations)
   - [Internal Customers](#internal-customers)
+  - [Internal Entitlements](#internal-entitlements)
   - [Internal Subscriptions](#internal-subscriptions)
   - [Internal Apps](#internal-apps)
   - [Internal Invoices](#internal-invoices)
@@ -305,10 +306,9 @@ The full call path, HTTP route, and a short description are listed below.
 
 ### Entitlements
 
-| Method                                   | HTTP                                                                             | Description                                    |
-| ---------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------- |
-| `client.entitlements.listCustomerAccess` | `GET /openmeter/customers/{customerId}/entitlement-access`                       | List customer entitlement access               |
-| `client.entitlements.getCustomerAccess`  | `GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}` | Get the customer's access to a single feature. |
+| Method                                   | HTTP                                                       | Description                      |
+| ---------------------------------------- | ---------------------------------------------------------- | -------------------------------- |
+| `client.entitlements.listCustomerAccess` | `GET /openmeter/customers/{customerId}/entitlement-access` | List customer entitlement access |
 
 ### Subscriptions
 
@@ -421,12 +421,19 @@ they can change or be removed without notice or semver consideration.
 
 ### Internal Customers
 
-| Method                                          | HTTP                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
-| ----------------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `client.internal.customers.entitlements.create` | `POST /openmeter/customers/{customerId}/entitlements`                        | Create an entitlement for the customer. A customer can have only one active entitlement per feature. The feature must be compatible with the entitlement type. Entitlements cannot be modified after creation, only deleted.                                                                                                                                                                                                                                                                                                                                                                    |
-| `client.internal.customers.credits.grants.void` | `POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/void` | Void a credit grant, forfeiting the remaining unused balance. Voiding is a forward-looking, irreversible operation. Credits already consumed by usage remain unaffected — only the remaining balance is forfeited. The grant reads as `voided` status afterwards. Payment state is not adjusted when `payment_adjustment` is `none`, so invoice-backed or externally collected payments may still collect the original amount. Only `active` grants can be voided; voiding a pending, expired, or fully consumed grant returns a conflict. Retrying a successful void is an idempotent success. |
-| `client.internal.customers.charges.list`        | `GET /openmeter/customers/{customerId}/charges`                              | List customer charges. Returns the customer's charges that are represented as either flat fee or usage-based charges.                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| `client.internal.customers.charges.create`      | `POST /openmeter/customers/{customerId}/charges`                             | Create customer charge.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Method                                              | HTTP                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| --------------------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `client.internal.customers.entitlements.create`     | `POST /openmeter/customers/{customerId}/entitlements`                        | Create an entitlement for the customer. A customer can have only one active entitlement per feature. The feature must be compatible with the entitlement type. Entitlements cannot be modified after creation, only deleted.                                                                                                                                                                                                                                                                                                                                                                    |
+| `client.internal.customers.entitlements.getHistory` | `GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history` | Get the balance and usage history of a metered entitlement. The queried range may span multiple usage periods. `windowed_history` groups usage into windows of the requested size and reports the balance at the start of each window. `burndown_history` lists the periods in which grants were consumed in a fixed order, together with the usage taken from each grant.                                                                                                                                                                                                                      |
+| `client.internal.customers.credits.grants.void`     | `POST /openmeter/customers/{customerId}/credits/grants/{creditGrantId}/void` | Void a credit grant, forfeiting the remaining unused balance. Voiding is a forward-looking, irreversible operation. Credits already consumed by usage remain unaffected — only the remaining balance is forfeited. The grant reads as `voided` status afterwards. Payment state is not adjusted when `payment_adjustment` is `none`, so invoice-backed or externally collected payments may still collect the original amount. Only `active` grants can be voided; voiding a pending, expired, or fully consumed grant returns a conflict. Retrying a successful void is an idempotent success. |
+| `client.internal.customers.charges.list`            | `GET /openmeter/customers/{customerId}/charges`                              | List customer charges. Returns the customer's charges that are represented as either flat fee or usage-based charges.                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| `client.internal.customers.charges.create`          | `POST /openmeter/customers/{customerId}/charges`                             | Create customer charge.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+
+### Internal Entitlements
+
+| Method                                           | HTTP                                                                             | Description                                    |
+| ------------------------------------------------ | -------------------------------------------------------------------------------- | ---------------------------------------------- |
+| `client.internal.entitlements.getCustomerAccess` | `GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}` | Get the customer's access to a single feature. |
 
 ### Internal Subscriptions
 

package/dist/funcs/customers.d.ts

@@ -1,6 +1,6 @@
 import { type Client } from '../core.js';
 import { type Result, type RequestOptions } from '../lib/types.js';
-import type { CreateCustomerRequest, CreateCustomerResponse, GetCustomerRequest, GetCustomerResponse, ListCustomersRequest, ListCustomersResponse, UpsertCustomerRequest, UpsertCustomerResponse, DeleteCustomerRequest, DeleteCustomerResponse, GetCustomerBillingRequest, GetCustomerBillingResponse, UpdateCustomerBillingRequest, UpdateCustomerBillingResponse, UpdateCustomerBillingAppDataRequest, UpdateCustomerBillingAppDataResponse, CreateCustomerStripeCheckoutSessionRequest, CreateCustomerStripeCheckoutSessionResponse, CreateCustomerStripePortalSessionRequest, CreateCustomerStripePortalSessionResponse, CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, CreateCreditGrantRequest, CreateCreditGrantResponse, GetCreditGrantRequest, GetCreditGrantResponse, ListCreditGrantsRequest, ListCreditGrantsResponse, GetCustomerCreditBalanceRequest, GetCustomerCreditBalanceResponse, CreateCreditAdjustmentRequest, CreateCreditAdjustmentResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, UpdateCreditGrantExternalSettlementRequest, UpdateCreditGrantExternalSettlementResponse, ListCreditTransactionsRequest, ListCreditTransactionsResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+import type { CreateCustomerRequest, CreateCustomerResponse, GetCustomerRequest, GetCustomerResponse, ListCustomersRequest, ListCustomersResponse, UpsertCustomerRequest, UpsertCustomerResponse, DeleteCustomerRequest, DeleteCustomerResponse, GetCustomerBillingRequest, GetCustomerBillingResponse, UpdateCustomerBillingRequest, UpdateCustomerBillingResponse, UpdateCustomerBillingAppDataRequest, UpdateCustomerBillingAppDataResponse, CreateCustomerStripeCheckoutSessionRequest, CreateCustomerStripeCheckoutSessionResponse, CreateCustomerStripePortalSessionRequest, CreateCustomerStripePortalSessionResponse, CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, GetCustomerEntitlementHistoryRequest, GetCustomerEntitlementHistoryResponse, CreateCreditGrantRequest, CreateCreditGrantResponse, GetCreditGrantRequest, GetCreditGrantResponse, ListCreditGrantsRequest, ListCreditGrantsResponse, GetCustomerCreditBalanceRequest, GetCustomerCreditBalanceResponse, CreateCreditAdjustmentRequest, CreateCreditAdjustmentResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, UpdateCreditGrantExternalSettlementRequest, UpdateCreditGrantExternalSettlementResponse, ListCreditTransactionsRequest, ListCreditTransactionsResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
 /**
  * Create customer
  *
@@ -92,6 +92,20 @@ export declare function createCustomerStripePortalSession(client: Client, req: C
  * POST /openmeter/customers/{customerId}/entitlements
  */
 export declare function createCustomerEntitlement(client: Client, req: CreateCustomerEntitlementRequest, options?: RequestOptions): Promise<Result<CreateCustomerEntitlementResponse>>;
+/**
+ * Get customer entitlement history
+ *
+ * Get the balance and usage history of a metered entitlement. The queried range
+ * may span multiple usage periods.
+ *
+ * `windowed_history` groups usage into windows of the requested size and reports
+ * the balance at the start of each window. `burndown_history` lists the periods in
+ * which grants were consumed in a fixed order, together with the usage taken from
+ * each grant.
+ *
+ * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
+ */
+export declare function getCustomerEntitlementHistory(client: Client, req: GetCustomerEntitlementHistoryRequest, options?: RequestOptions): Promise<Result<GetCustomerEntitlementHistoryResponse>>;
 /**
  * Create a new credit grant
  *

package/dist/funcs/customers.js

@@ -394,6 +394,63 @@ export function createCustomerEntitlement(client, req, options) {
         });
     });
 }
+/**
+ * Get customer entitlement history
+ *
+ * Get the balance and usage history of a metered entitlement. The queried range
+ * may span multiple usage periods.
+ *
+ * `windowed_history` groups usage into windows of the requested size and reports
+ * the balance at the start of each window. `burndown_history` lists the periods in
+ * which grants were consumed in a fixed order, together with the usage taken from
+ * each grant.
+ *
+ * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
+ */
+export function getCustomerEntitlementHistory(client, req, options) {
+    return request(() => {
+        const pathParamsInput = {
+            customerId: req.customerId,
+            entitlementId: req.entitlementId,
+        };
+        const pathParams = client._options.validate
+            ? toPathWire(pathParamsInput, schemas.getCustomerEntitlementHistoryPathParams)
+            : pathParamsInput;
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementHistoryPathParamsWire, pathParams);
+        }
+        const path = `openmeter/customers/${(() => {
+            if (pathParams.customerId === undefined) {
+                throw new Error('missing path parameter: customerId');
+            }
+            return encodeURIComponent(String(pathParams.customerId));
+        })()}/entitlements/${(() => {
+            if (pathParams.entitlementId === undefined) {
+                throw new Error('missing path parameter: entitlementId');
+            }
+            return encodeURIComponent(String(pathParams.entitlementId));
+        })()}/history`;
+        const query = toWire({
+            from: req.from,
+            to: req.to,
+            windowSize: req.windowSize,
+            timeZone: req.timeZone,
+        }, schemas.getCustomerEntitlementHistoryQueryParams);
+        if (client._options.validate) {
+            assertValid(schemas.getCustomerEntitlementHistoryQueryParamsWire, query);
+        }
+        const searchParams = toURLSearchParams(query);
+        return http(client)
+            .get(path, { ...options, searchParams })
+            .json()
+            .then((data) => {
+            if (client._options.validate) {
+                assertValid(schemas.getCustomerEntitlementHistoryResponseWire, data);
+            }
+            return fromWire(data, schemas.getCustomerEntitlementHistoryResponse);
+        });
+    });
+}
 /**
  * Create a new credit grant
  *

package/dist/index.d.ts

@@ -42,4 +42,4 @@ export type * from './models/operations/addons.js';
 export type * from './models/operations/planAddons.js';
 export type * from './models/operations/defaults.js';
 export type * from './models/operations/entitlementAccess.js';
-export type { Labels, CursorPaginationQueryPage, SortQuery, IngestedEventValidationError, CursorMetaPage, BaseError, PageMeta, QueryFilterString, AppStripeCheckoutSessionCustomTextParams, AppStripeCreateCustomerPortalSessionOptions, CreateLabels, PriceFree, RateCardStaticEntitlement, RateCardBooleanEntitlement, TaxConfigStripe, TaxConfigExternalInvoicing, InvoiceExternalReferences, InvoiceAvailableActionDetails, InvoiceWorkflowInvoicingSettings, WorkflowPaymentChargeAutomaticallySettings, WorkflowPaymentSendInvoiceSettings, ChargeFlatFeeDiscounts, SubscriptionEditRemoveItem, SubscriptionEditUnscheduleEdit, UpdateLabels, InstallAppStripeWithApiKey, InstallAppSandbox, InstallAppExternalInvoicing, WorkflowCollectionAlignmentSubscription, InvoiceLineExternalReferences, UpdateBillingInvoiceWorkflowInvoicingSettings, UpdateBillingWorkflowPaymentChargeAutomaticallySettings, UpdateBillingWorkflowPaymentSendInvoiceSettings, UpdatePriceFree, LlmCostProvider, LlmCostModel, ProductCatalogValidationError, EntitlementAccessQueryRequestCustomers, EntitlementAccessQueryRequestFeatures, QueryFilterInteger, QueryFilterFloat, QueryFilterBoolean, PagePaginationQuery, PublicLabels, SystemAccountAccessToken, PersonalAccessToken, KonnectAccessToken, AppCustomerDataStripe, AppCustomerDataExternalInvoicing, CreateChargeCostBasisDynamic, ChargeCostBasisDynamic, CurrencyFiat, ListCostBasesParamsFilter, CreateCurrencyCustomRequest, EntitlementAccessValue, EntitlementIssueAfterReset, CreateChargeCostBasisManual, ChargeCostBasisManual, PriceFlat, PriceUnit, SpendCommitments, RateCardDiscounts, Totals, ChargeRealizationDetailedLineCreditApplied, ChargeRealizationAmountDiscount, FeatureManualUnitCost, FeatureLlmUnitCostPricing, InvoiceLineCreditsApplied, InvoiceUsageQuantityDetail, UpdatePriceFlat, UpdatePriceUnit, UpdateDiscounts, LlmCostModelPricing, FiatCurrencyAmount, QueryFilterNumeric, CursorPaginationQuery, ListMetersParamsFilter, ListLlmCostPricesParamsFilter, LabelsFieldFilter, CustomerReference, ProfileReference, FeatureReference, CreateChargeCostBasisPinned, CreateResourceReference, ChargeCostBasisPinned, TaxCodeReference, CreditGrantInvoiceReference, CurrencyCustomReference, SubscriptionCostBasisPin, SubscriptionReference, AppReference, ChargeRealizationInvoiceReference, AddonReference, ChargeReference, UpdateResourceReference, BillingCustomerReference, ChargeFeature, Event, MeterQueryRow, AppStripeCreateCustomerPortalSessionResult, ClosedPeriod, ChargeResolvedCostBasis, SubscriptionAddonTimelineSegment, UpdateClosedPeriod, CostBasis, FeatureCostQueryRow, Resource, ResourceImmutable, QueryFilterDateTime, CursorMeta, InvalidParameterStandard, InvalidParameterMinimumLength, InvalidParameterMaximumLength, InvalidParameterChoiceItem, InvalidParameterDependentItem, Unauthorized, Forbidden, NotFound, Gone, Conflict, PayloadTooLarge, UnsupportedMediaType, UnprocessableContent, TooManyRequests, Internal, NotImplemented, NotAvailable, CreateCreditGrantFilters, CreditGrantFilters, SubscriptionPlanReference, UpsertPlanAddonRequest, ResourceWithKey, Meter, PaginatedMeta, QueryFilterStringMapItem, CustomerKeyReference, CustomerUsageAttribution, UpdateCustomerUsageAttribution, Address, UpdateAddress, AppStripeCreateCheckoutSessionCustomerUpdate, AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement, AppStripeCreateCheckoutSessionTaxIdCollection, AppStripeCreateCheckoutSessionResult, CustomerStripeCreateCustomerPortalSessionRequest, RecurringPeriodInput, RecurringPeriod, RateCardMeteredEntitlement, SubscriptionPhaseCreate, SubscriptionEditStretchPhase, ListCreditGrantsParamsFilter, ValidationIssue, GetCreditBalanceParamsFilter, ListPlansParamsFilter, SubscriptionProRatingConfig, RateCardProrationConfiguration, UnitConfig, PartyTaxIdentity, UpdateBillingPartyTaxIdentity, InvoiceAvailableActions, ChargeRealizationPayment, SubscriptionEditRemovePhase, TaxCodeAppMapping, AppCapability, UpdateAppStripeRequest, UpdateAppSandboxRequest, UpdateAppExternalInvoicingRequest, WorkflowInvoicingSettings, InvoiceLineAmountDiscount, InvoiceLineUsageDiscount, InvoiceLineBaseDiscount, ListCurrenciesParamsFilter, EntitlementAccessQueryRequest, EntitlementFeatureAccessReason, EntitlementAccessQueryError, AppCustomerData, UpsertAppCustomerDataRequest, CreditAdjustment, ListCreditTransactionsParamsFilter, CurrencyAmount, EntitlementAccessResult, PriceTier, ChargeTotals, FeatureLlmUnitCost, UpdatePriceTier, LlmCostPrice, LlmCostOverrideCreate, ListCustomersParamsFilter, ListSubscriptionsParamsFilter, ListAppsParamsFilter, ListBillingProfilesParamsFilter, ListFeatureParamsFilter, ListAddonsParamsFilter, ListPlanAddonsParamsFilter, CreateTaxCodeConfig, TaxCodeConfig, TaxConfig, OrganizationDefaultTaxCodes, CreditBalance, CreditTransaction, InvoiceWorkflowAppsReferences, ProfileAppReferences, PlanAddon, UpdateTaxCodeConfig, ListEventsParamsFilter, ListCustomerChargesParamsFilter, ListInvoicesParamsFilter, ListChargesParamsFilter, ResourceFilters, FieldFilters, IngestedEvent, MeterQueryResult, ChargeRealizationDetailedLineFlatFee, ChargeRealizationDetailedLineUsageBased, CurrencyCustom, FeatureCostQueryResult, MeterPagePaginatedResponse, CostBasisPagePaginatedResponse, MeterQueryFilters, FeatureMeterReference, Customer, PartyAddresses, InvoiceCustomer, UpdateBillingPartyAddresses, UpdateInvoiceCustomer, AppStripeCreateCheckoutSessionConsentCollection, EntitlementGrantCreateRequest, CreateEntitlementStaticRequest, CreateEntitlementBooleanRequest, EntitlementMetered, EntitlementStatic, EntitlementBoolean, WorkflowCollectionAlignmentAnchored, SubscriptionEditAddPhase, SubscriptionBase, InvoiceStatusDetails, InvoiceWorkflow, SubscriptionCancel, SubscriptionMigrate, SubscriptionAddonUpdate, TaxCode, AppCatalogItem, InvoiceLineDiscounts, UpdateBillingInvoiceWorkflow, EntitlementFeatureAccess, CustomerData, UpsertCustomerBillingDataRequest, ChargeFlatFeeSystemIntent, ListCustomerEntitlementAccessResponseData, PriceGraduated, PriceVolume, UpdatePriceGraduated, UpdatePriceVolume, PricePagePaginatedResponse, CreateCreditGrantPurchase, CreditGrantPurchase, CreateChargeFlatFeeRequest, WorkflowTaxSettings, CreditBalances, CreditTransactionPaginatedResponse, PlanAddonPagePaginatedResponse, IngestedEventPaginatedResponse, InvalidParameters, MeterQueryRequest, CustomerPagePaginatedResponse, Supplier, Party, UpdateSupplier, AppStripeCreateCheckoutSessionRequestOptions, CreateEntitlementMeteredRequest, InvoiceWorkflowSettings, TaxCodePagePaginatedResponse, AppStripe, AppSandbox, AppExternalInvoicing, AppCatalogItemPagePaginatedResponse, InstalledAppStripe, InstalledAppSandbox, InstalledAppExternalInvoicing, InvoiceDetailedLine, UpdateInvoiceWorkflowSettings, EntitlementAccessQueryResult, Feature, CreditGrant, CurrencyPagePaginatedResponse, BadRequest, InvoiceBase, CustomerStripeCreateCheckoutSessionRequest, WorkflowCollectionSettings, ChargeRealizationInvoice, EntitlementAccessQueryResponse, RateCard, InvoiceLineRateCard, ChargeUsageBasedSystemIntent, CreateChargeUsageBasedRequest, FeaturePagePaginatedResponse, UpdateInvoiceLineRateCard, CreditGrantPagePaginatedResponse, Workflow, AppPagePaginatedResponse, ProfileApps, SubscriptionItem, PlanPhase, SubscriptionEditAddItem, SubscriptionAddonRateCard, Addon, UpsertAddonRequest, InvoiceStandardLine, UpdateInvoiceStandardLine, Profile, UpsertBillingProfileRequest, ChargeRealization, SubscriptionPhase, SubscriptionCustomPlan, Plan, UpsertPlanRequest, SubscriptionAddon, AddonPagePaginatedResponse, ProfilePagePaginatedResponse, Subscription, SubscriptionCreate, SubscriptionChange, PlanPagePaginatedResponse, SubscriptionEdit, SubscriptionAddonPagePaginatedResponse, InvoiceStandard, UpdateInvoiceStandardRequest, SubscriptionPagePaginatedResponse, SubscriptionChangeResponse, SubscriptionMigrateResponse, ChargeFlatFee, ChargeUsageBased, InvoicePagePaginatedResponse, ChargePagePaginatedResponse, StringFieldFilter, MeterAggregation, MeterQueryGranularity, StringFieldFilterExact, PricePaymentTerm, BillingCurrencyCode, CreateCurrencyCode, UlidFieldFilter, DateTimeFieldFilter, EntitlementMeasureUsageFrom, WorkflowPaymentSettings, SubscriptionCreateTiming, SubscriptionEditTiming, UpdateBillingWorkflowPaymentSettings, CreateChargeCostBasis, ChargeCostBasis, InvalidParameter, RateCardEntitlement, FeatureUnitCost, ChargeRealizationDetailedLine, Currency, CustomerOrReference, Entitlement, WorkflowCollectionAlignment, Price, PriceUsageBased, UpdatePrice, CreateEntitlementRequest, App, BillingInstallAppResponse, FeatureOrReference, ChargeRealizationInvoiceOrReference, CreateChargeRequest, SubscriptionEditOperation, InvoiceLine, UpdateInvoiceLine, SubscriptionOrReference, Invoice, Charge, SortQueryInput, BaseErrorInput, InvoiceWorkflowInvoicingSettingsInput, WorkflowPaymentSendInvoiceSettingsInput, UpdateBillingInvoiceWorkflowInvoicingSettingsInput, UpdateBillingWorkflowPaymentSendInvoiceSettingsInput, EntitlementIssueAfterResetInput, EventInput, UnauthorizedInput, ForbiddenInput, NotFoundInput, GoneInput, ConflictInput, PayloadTooLargeInput, UnsupportedMediaTypeInput, UnprocessableContentInput, TooManyRequestsInput, InternalInput, NotImplementedInput, NotAvailableInput, AppStripeCreateCheckoutSessionCustomerUpdateInput, AppStripeCreateCheckoutSessionTaxIdCollectionInput, RateCardMeteredEntitlementInput, VoidCreditGrantRequestInput, UnitConfigInput, WorkflowInvoicingSettingsInput, EntitlementAccessQueryRequestInput, IngestedEventInput, EntitlementMeteredInput, SubscriptionBaseInput, InvoiceWorkflowInput, SubscriptionCancelInput, SubscriptionMigrateInput, UpdateBillingInvoiceWorkflowInput, CreateCreditGrantPurchaseInput, CreditGrantPurchaseInput, WorkflowTaxSettingsInput, IngestedEventPaginatedResponseInput, MeterQueryRequestInput, AppStripeCreateCheckoutSessionRequestOptionsInput, CreateEntitlementMeteredRequestInput, InvoiceWorkflowSettingsInput, InvoiceDetailedLineInput, UpdateInvoiceWorkflowSettingsInput, CreateCreditGrantRequestInput, CreditGrantInput, BadRequestInput, CustomerStripeCreateCheckoutSessionRequestInput, WorkflowCollectionSettingsInput, ChargeRealizationInvoiceInput, RateCardInput, InvoiceLineRateCardInput, ChargeUsageBasedSystemIntentInput, CreateChargeUsageBasedRequestInput, CreditGrantPagePaginatedResponseInput, WorkflowInput, SubscriptionItemInput, PlanPhaseInput, SubscriptionEditAddItemInput, SubscriptionAddonRateCardInput, AddonInput, CreateAddonRequestInput, UpsertAddonRequestInput, InvoiceStandardLineInput, ProfileInput, CreateBillingProfileRequestInput, UpsertBillingProfileRequestInput, ChargeRealizationInput, SubscriptionPhaseInput, SubscriptionCustomPlanInput, PlanInput, CreatePlanRequestInput, UpsertPlanRequestInput, SubscriptionAddonInput, AddonPagePaginatedResponseInput, ProfilePagePaginatedResponseInput, SubscriptionInput, SubscriptionCreateInput, SubscriptionChangeInput, PlanPagePaginatedResponseInput, SubscriptionEditInput, SubscriptionAddonPagePaginatedResponseInput, InvoiceStandardInput, UpdateInvoiceStandardRequestInput, SubscriptionPagePaginatedResponseInput, SubscriptionChangeResponseInput, SubscriptionMigrateResponseInput, ChargeFlatFeeInput, ChargeUsageBasedInput, InvoicePagePaginatedResponseInput, ChargePagePaginatedResponseInput, WorkflowPaymentSettingsInput, UpdateBillingWorkflowPaymentSettingsInput, RateCardEntitlementInput, EntitlementInput, CreateEntitlementRequestInput, ChargeRealizationInvoiceOrReferenceInput, CreateChargeRequestInput, SubscriptionEditOperationInput, InvoiceLineInput, SubscriptionOrReferenceInput, InvoiceInput, UpdateInvoiceRequestInput, ChargeInput, } from './models/types.js';
+export type { Labels, CursorPaginationQueryPage, SortQuery, IngestedEventValidationError, CursorMetaPage, BaseError, PageMeta, QueryFilterString, AppStripeCheckoutSessionCustomTextParams, AppStripeCreateCustomerPortalSessionOptions, CreateLabels, PriceFree, RateCardStaticEntitlement, RateCardBooleanEntitlement, TaxConfigStripe, TaxConfigExternalInvoicing, InvoiceExternalReferences, InvoiceAvailableActionDetails, InvoiceWorkflowInvoicingSettings, WorkflowPaymentChargeAutomaticallySettings, WorkflowPaymentSendInvoiceSettings, ChargeFlatFeeDiscounts, SubscriptionEditRemoveItem, SubscriptionEditUnscheduleEdit, UpdateLabels, InstallAppStripeWithApiKey, InstallAppSandbox, InstallAppExternalInvoicing, WorkflowCollectionAlignmentSubscription, InvoiceLineExternalReferences, UpdateBillingInvoiceWorkflowInvoicingSettings, UpdateBillingWorkflowPaymentChargeAutomaticallySettings, UpdateBillingWorkflowPaymentSendInvoiceSettings, UpdatePriceFree, LlmCostProvider, LlmCostModel, ProductCatalogValidationError, EntitlementAccessQueryRequestCustomers, EntitlementAccessQueryRequestFeatures, QueryFilterInteger, QueryFilterFloat, QueryFilterBoolean, PagePaginationQuery, PublicLabels, SystemAccountAccessToken, PersonalAccessToken, KonnectAccessToken, AppCustomerDataStripe, AppCustomerDataExternalInvoicing, CreateChargeCostBasisDynamic, ChargeCostBasisDynamic, CurrencyFiat, ListCostBasesParamsFilter, CreateCurrencyCustomRequest, EntitlementAccessValue, EntitlementIssueAfterReset, EntitlementBurndownBalance, EntitlementBurndownGrantBalances, CreateChargeCostBasisManual, ChargeCostBasisManual, PriceFlat, PriceUnit, SpendCommitments, RateCardDiscounts, Totals, ChargeRealizationDetailedLineCreditApplied, ChargeRealizationAmountDiscount, FeatureManualUnitCost, FeatureLlmUnitCostPricing, InvoiceLineCreditsApplied, InvoiceUsageQuantityDetail, UpdatePriceFlat, UpdatePriceUnit, UpdateDiscounts, LlmCostModelPricing, FiatCurrencyAmount, QueryFilterNumeric, CursorPaginationQuery, ListMetersParamsFilter, ListLlmCostPricesParamsFilter, LabelsFieldFilter, CustomerReference, ProfileReference, FeatureReference, EntitlementGrantUsage, CreateChargeCostBasisPinned, CreateResourceReference, ChargeCostBasisPinned, TaxCodeReference, CreditGrantInvoiceReference, CurrencyCustomReference, SubscriptionCostBasisPin, SubscriptionReference, AppReference, ChargeRealizationInvoiceReference, AddonReference, ChargeReference, UpdateResourceReference, BillingCustomerReference, ChargeFeature, Event, MeterQueryRow, AppStripeCreateCustomerPortalSessionResult, ClosedPeriod, ChargeResolvedCostBasis, SubscriptionAddonTimelineSegment, UpdateClosedPeriod, CostBasis, FeatureCostQueryRow, Resource, ResourceImmutable, QueryFilterDateTime, CursorMeta, InvalidParameterStandard, InvalidParameterMinimumLength, InvalidParameterMaximumLength, InvalidParameterChoiceItem, InvalidParameterDependentItem, Unauthorized, Forbidden, NotFound, Gone, Conflict, PayloadTooLarge, UnsupportedMediaType, UnprocessableContent, TooManyRequests, Internal, NotImplemented, NotAvailable, CreateCreditGrantFilters, CreditGrantFilters, SubscriptionPlanReference, UpsertPlanAddonRequest, ResourceWithKey, Meter, PaginatedMeta, QueryFilterStringMapItem, CustomerKeyReference, CustomerUsageAttribution, UpdateCustomerUsageAttribution, Address, UpdateAddress, AppStripeCreateCheckoutSessionCustomerUpdate, AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement, AppStripeCreateCheckoutSessionTaxIdCollection, AppStripeCreateCheckoutSessionResult, CustomerStripeCreateCustomerPortalSessionRequest, RecurringPeriodInput, RecurringPeriod, RateCardMeteredEntitlement, SubscriptionPhaseCreate, SubscriptionEditStretchPhase, ListCreditGrantsParamsFilter, ValidationIssue, GetCreditBalanceParamsFilter, ListPlansParamsFilter, SubscriptionProRatingConfig, RateCardProrationConfiguration, UnitConfig, PartyTaxIdentity, UpdateBillingPartyTaxIdentity, InvoiceAvailableActions, ChargeRealizationPayment, SubscriptionEditRemovePhase, TaxCodeAppMapping, AppCapability, UpdateAppStripeRequest, UpdateAppSandboxRequest, UpdateAppExternalInvoicingRequest, WorkflowInvoicingSettings, InvoiceLineAmountDiscount, InvoiceLineUsageDiscount, InvoiceLineBaseDiscount, ListCurrenciesParamsFilter, EntitlementAccessQueryRequest, EntitlementFeatureAccessReason, EntitlementAccessQueryError, AppCustomerData, UpsertAppCustomerDataRequest, CreditAdjustment, ListCreditTransactionsParamsFilter, CurrencyAmount, EntitlementAccessResult, PriceTier, ChargeTotals, FeatureLlmUnitCost, UpdatePriceTier, LlmCostPrice, LlmCostOverrideCreate, ListCustomersParamsFilter, ListSubscriptionsParamsFilter, ListAppsParamsFilter, ListBillingProfilesParamsFilter, ListFeatureParamsFilter, ListAddonsParamsFilter, ListPlanAddonsParamsFilter, CreateTaxCodeConfig, TaxCodeConfig, TaxConfig, OrganizationDefaultTaxCodes, CreditBalance, CreditTransaction, InvoiceWorkflowAppsReferences, ProfileAppReferences, PlanAddon, UpdateTaxCodeConfig, ListEventsParamsFilter, ListCustomerChargesParamsFilter, ListInvoicesParamsFilter, ListChargesParamsFilter, ResourceFilters, FieldFilters, IngestedEvent, MeterQueryResult, EntitlementHistoryWindow, EntitlementBurndownSegment, ChargeRealizationDetailedLineFlatFee, ChargeRealizationDetailedLineUsageBased, CurrencyCustom, FeatureCostQueryResult, MeterPagePaginatedResponse, CostBasisPagePaginatedResponse, MeterQueryFilters, FeatureMeterReference, Customer, PartyAddresses, InvoiceCustomer, UpdateBillingPartyAddresses, UpdateInvoiceCustomer, AppStripeCreateCheckoutSessionConsentCollection, EntitlementGrantCreateRequest, CreateEntitlementStaticRequest, CreateEntitlementBooleanRequest, EntitlementMetered, EntitlementStatic, EntitlementBoolean, WorkflowCollectionAlignmentAnchored, SubscriptionEditAddPhase, SubscriptionBase, InvoiceStatusDetails, InvoiceWorkflow, SubscriptionCancel, SubscriptionMigrate, SubscriptionAddonUpdate, TaxCode, AppCatalogItem, InvoiceLineDiscounts, UpdateBillingInvoiceWorkflow, EntitlementFeatureAccess, CustomerData, UpsertCustomerBillingDataRequest, ChargeFlatFeeSystemIntent, ListCustomerEntitlementAccessResponseData, PriceGraduated, PriceVolume, UpdatePriceGraduated, UpdatePriceVolume, PricePagePaginatedResponse, CreateCreditGrantPurchase, CreditGrantPurchase, CreateChargeFlatFeeRequest, WorkflowTaxSettings, CreditBalances, CreditTransactionPaginatedResponse, PlanAddonPagePaginatedResponse, IngestedEventPaginatedResponse, EntitlementHistory, InvalidParameters, MeterQueryRequest, CustomerPagePaginatedResponse, Supplier, Party, UpdateSupplier, AppStripeCreateCheckoutSessionRequestOptions, CreateEntitlementMeteredRequest, InvoiceWorkflowSettings, TaxCodePagePaginatedResponse, AppStripe, AppSandbox, AppExternalInvoicing, AppCatalogItemPagePaginatedResponse, InstalledAppStripe, InstalledAppSandbox, InstalledAppExternalInvoicing, InvoiceDetailedLine, UpdateInvoiceWorkflowSettings, EntitlementAccessQueryResult, Feature, CreditGrant, CurrencyPagePaginatedResponse, BadRequest, InvoiceBase, CustomerStripeCreateCheckoutSessionRequest, WorkflowCollectionSettings, ChargeRealizationInvoice, EntitlementAccessQueryResponse, RateCard, InvoiceLineRateCard, ChargeUsageBasedSystemIntent, CreateChargeUsageBasedRequest, FeaturePagePaginatedResponse, UpdateInvoiceLineRateCard, CreditGrantPagePaginatedResponse, Workflow, AppPagePaginatedResponse, ProfileApps, SubscriptionItem, PlanPhase, SubscriptionEditAddItem, SubscriptionAddonRateCard, Addon, UpsertAddonRequest, InvoiceStandardLine, UpdateInvoiceStandardLine, Profile, UpsertBillingProfileRequest, ChargeRealization, SubscriptionPhase, SubscriptionCustomPlan, Plan, UpsertPlanRequest, SubscriptionAddon, AddonPagePaginatedResponse, ProfilePagePaginatedResponse, Subscription, SubscriptionCreate, SubscriptionChange, PlanPagePaginatedResponse, SubscriptionEdit, SubscriptionAddonPagePaginatedResponse, InvoiceStandard, UpdateInvoiceStandardRequest, SubscriptionPagePaginatedResponse, SubscriptionChangeResponse, SubscriptionMigrateResponse, ChargeFlatFee, ChargeUsageBased, InvoicePagePaginatedResponse, ChargePagePaginatedResponse, StringFieldFilter, MeterAggregation, MeterQueryGranularity, EntitlementHistoryWindowSize, StringFieldFilterExact, PricePaymentTerm, BillingCurrencyCode, CreateCurrencyCode, UlidFieldFilter, DateTimeFieldFilter, EntitlementMeasureUsageFrom, WorkflowPaymentSettings, SubscriptionCreateTiming, SubscriptionEditTiming, UpdateBillingWorkflowPaymentSettings, CreateChargeCostBasis, ChargeCostBasis, InvalidParameter, RateCardEntitlement, FeatureUnitCost, ChargeRealizationDetailedLine, Currency, CustomerOrReference, Entitlement, WorkflowCollectionAlignment, Price, PriceUsageBased, UpdatePrice, CreateEntitlementRequest, App, BillingInstallAppResponse, FeatureOrReference, ChargeRealizationInvoiceOrReference, CreateChargeRequest, SubscriptionEditOperation, InvoiceLine, UpdateInvoiceLine, SubscriptionOrReference, Invoice, Charge, SortQueryInput, BaseErrorInput, InvoiceWorkflowInvoicingSettingsInput, WorkflowPaymentSendInvoiceSettingsInput, UpdateBillingInvoiceWorkflowInvoicingSettingsInput, UpdateBillingWorkflowPaymentSendInvoiceSettingsInput, EntitlementIssueAfterResetInput, EventInput, UnauthorizedInput, ForbiddenInput, NotFoundInput, GoneInput, ConflictInput, PayloadTooLargeInput, UnsupportedMediaTypeInput, UnprocessableContentInput, TooManyRequestsInput, InternalInput, NotImplementedInput, NotAvailableInput, AppStripeCreateCheckoutSessionCustomerUpdateInput, AppStripeCreateCheckoutSessionTaxIdCollectionInput, RateCardMeteredEntitlementInput, VoidCreditGrantRequestInput, UnitConfigInput, WorkflowInvoicingSettingsInput, EntitlementAccessQueryRequestInput, IngestedEventInput, EntitlementMeteredInput, SubscriptionBaseInput, InvoiceWorkflowInput, SubscriptionCancelInput, SubscriptionMigrateInput, UpdateBillingInvoiceWorkflowInput, CreateCreditGrantPurchaseInput, CreditGrantPurchaseInput, WorkflowTaxSettingsInput, IngestedEventPaginatedResponseInput, MeterQueryRequestInput, AppStripeCreateCheckoutSessionRequestOptionsInput, CreateEntitlementMeteredRequestInput, InvoiceWorkflowSettingsInput, InvoiceDetailedLineInput, UpdateInvoiceWorkflowSettingsInput, CreateCreditGrantRequestInput, CreditGrantInput, BadRequestInput, CustomerStripeCreateCheckoutSessionRequestInput, WorkflowCollectionSettingsInput, ChargeRealizationInvoiceInput, RateCardInput, InvoiceLineRateCardInput, ChargeUsageBasedSystemIntentInput, CreateChargeUsageBasedRequestInput, CreditGrantPagePaginatedResponseInput, WorkflowInput, SubscriptionItemInput, PlanPhaseInput, SubscriptionEditAddItemInput, SubscriptionAddonRateCardInput, AddonInput, CreateAddonRequestInput, UpsertAddonRequestInput, InvoiceStandardLineInput, ProfileInput, CreateBillingProfileRequestInput, UpsertBillingProfileRequestInput, ChargeRealizationInput, SubscriptionPhaseInput, SubscriptionCustomPlanInput, PlanInput, CreatePlanRequestInput, UpsertPlanRequestInput, SubscriptionAddonInput, AddonPagePaginatedResponseInput, ProfilePagePaginatedResponseInput, SubscriptionInput, SubscriptionCreateInput, SubscriptionChangeInput, PlanPagePaginatedResponseInput, SubscriptionEditInput, SubscriptionAddonPagePaginatedResponseInput, InvoiceStandardInput, UpdateInvoiceStandardRequestInput, SubscriptionPagePaginatedResponseInput, SubscriptionChangeResponseInput, SubscriptionMigrateResponseInput, ChargeFlatFeeInput, ChargeUsageBasedInput, InvoicePagePaginatedResponseInput, ChargePagePaginatedResponseInput, WorkflowPaymentSettingsInput, UpdateBillingWorkflowPaymentSettingsInput, RateCardEntitlementInput, EntitlementInput, CreateEntitlementRequestInput, ChargeRealizationInvoiceOrReferenceInput, CreateChargeRequestInput, SubscriptionEditOperationInput, InvoiceLineInput, SubscriptionOrReferenceInput, InvoiceInput, UpdateInvoiceRequestInput, ChargeInput, } from './models/types.js';

package/dist/lib/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.0-beta-89ad46498d71";
+export declare const SDK_VERSION = "1.0.0-beta-2b50cff9e992";

package/dist/lib/version.js

@@ -2,4 +2,4 @@
 // The committed value is a dev placeholder. The publish flow
 // (`make -C api/spec publish-aip-sdk`) stamps the real release version here
 // before `pnpm publish`, after `pnpm version` updates package.json.
-export const SDK_VERSION = '1.0.0-beta-89ad46498d71';
+export const SDK_VERSION = '1.0.0-beta-2b50cff9e992';

package/dist/models/operations/customers.d.ts

@@ -1,5 +1,5 @@
 import type { AcceptDateStrings } from '../../lib/wire.js';
-import type { AppCustomerData, AppStripeCreateCheckoutSessionResult, AppStripeCreateCustomerPortalSessionResult, Charge, ChargePagePaginatedResponse, CreateChargeRequestInput, CreateCreditAdjustmentRequest as CreateCreditAdjustmentRequestBody, CreateCreditGrantRequestInput, CreateCustomerRequest as CreateCustomerRequestBody, CreateEntitlementRequestInput, CreditAdjustment, CreditBalances, CreditGrant, CreditGrantPagePaginatedResponse, CreditTransactionPaginatedResponse, CursorPaginationQueryPage, Customer, CustomerData, CustomerPagePaginatedResponse, CustomerStripeCreateCheckoutSessionRequestInput, CustomerStripeCreateCustomerPortalSessionRequest, Entitlement, GetCreditBalanceParamsFilter, ListCreditGrantsParamsFilter, ListCreditTransactionsParamsFilter, ListCustomerChargesParamsFilter, ListCustomersParamsFilter, SortQueryInput, UpdateCreditGrantExternalSettlementRequest as UpdateCreditGrantExternalSettlementRequestBody, UpsertAppCustomerDataRequest, UpsertCustomerBillingDataRequest, UpsertCustomerRequest as UpsertCustomerRequestBody, VoidCreditGrantRequestInput } from '../types.js';
+import type { AppCustomerData, AppStripeCreateCheckoutSessionResult, AppStripeCreateCustomerPortalSessionResult, Charge, ChargePagePaginatedResponse, CreateChargeRequestInput, CreateCreditAdjustmentRequest as CreateCreditAdjustmentRequestBody, CreateCreditGrantRequestInput, CreateCustomerRequest as CreateCustomerRequestBody, CreateEntitlementRequestInput, CreditAdjustment, CreditBalances, CreditGrant, CreditGrantPagePaginatedResponse, CreditTransactionPaginatedResponse, CursorPaginationQueryPage, Customer, CustomerData, CustomerPagePaginatedResponse, CustomerStripeCreateCheckoutSessionRequestInput, CustomerStripeCreateCustomerPortalSessionRequest, Entitlement, EntitlementHistory, EntitlementHistoryWindowSize, GetCreditBalanceParamsFilter, ListCreditGrantsParamsFilter, ListCreditTransactionsParamsFilter, ListCustomerChargesParamsFilter, ListCustomersParamsFilter, SortQueryInput, UpdateCreditGrantExternalSettlementRequest as UpdateCreditGrantExternalSettlementRequestBody, UpsertAppCustomerDataRequest, UpsertCustomerBillingDataRequest, UpsertCustomerRequest as UpsertCustomerRequestBody, VoidCreditGrantRequestInput } from '../types.js';
 export type CreateCustomerRequest = AcceptDateStrings<CreateCustomerRequestBody>;
 export type CreateCustomerResponse = Customer;
 export type GetCustomerRequest = {
@@ -70,6 +70,27 @@ export type CreateCustomerEntitlementRequest = AcceptDateStrings<{
     body: CreateEntitlementRequestInput;
 }>;
 export type CreateCustomerEntitlementResponse = Entitlement;
+export interface GetCustomerEntitlementHistoryQuery {
+    /**
+     * The start of the queried range. Defaults to the last reset. Truncated to the
+     * minute. The range may span at most 1000 windows.
+     */
+    from?: Date;
+    /**
+     * The end of the queried range. Defaults to the current time. Truncated to the
+     * minute unless it is the current time.
+     */
+    to?: Date;
+    /** The size of the windows the usage is grouped into. */
+    windowSize: EntitlementHistoryWindowSize;
+    /** The IANA time zone the windows are aligned to. */
+    timeZone?: string;
+}
+export type GetCustomerEntitlementHistoryRequest = AcceptDateStrings<GetCustomerEntitlementHistoryQuery & {
+    customerId: string;
+    entitlementId: string;
+}>;
+export type GetCustomerEntitlementHistoryResponse = EntitlementHistory;
 export type CreateCreditGrantRequest = AcceptDateStrings<{
     customerId: string;
     body: CreateCreditGrantRequestInput;

package/dist/models/schemas.d.ts

@@ -178,6 +178,7 @@ export declare const entitlementMeasureUsageFromPreset: z.ZodEnum<{
     current_period_start: "current_period_start";
     now: "now";
 }>;
+export declare const entitlementHistoryWindowSize: z.ZodUnion<readonly [z.ZodLiteral<"PT1H">, z.ZodLiteral<"P1D">]>;
 export declare const createLabels: z.ZodRecord<z.ZodString, z.ZodString>;
 export declare const creditFundingMethod: z.ZodEnum<{
     external: "external";
@@ -639,6 +640,14 @@ export declare const entitlementIssueAfterReset: z.ZodObject<{
     amount: z.ZodString;
     priority: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
 }, z.core.$strip>;
+export declare const entitlementBurndownBalance: z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, z.core.$strip>;
+export declare const entitlementBurndownGrantBalances: z.ZodObject<{
+    start: z.ZodRecord<z.ZodString, z.ZodString>;
+    end: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
 export declare const createChargeCostBasisManual: z.ZodObject<{
     type: z.ZodLiteral<"manual">;
     fiatCurrency: z.ZodOptional<z.ZodString>;
@@ -859,6 +868,10 @@ export declare const profileReference: z.ZodObject<{
 export declare const featureReference: z.ZodObject<{
     id: z.ZodString;
 }, z.core.$strip>;
+export declare const entitlementGrantUsage: z.ZodObject<{
+    grantId: z.ZodString;
+    usage: z.ZodString;
+}, z.core.$strip>;
 export declare const createChargeCostBasisPinned: z.ZodObject<{
     type: z.ZodLiteral<"pinned">;
     fiatCurrency: z.ZodString;
@@ -2675,6 +2688,34 @@ export declare const meterQueryResult: z.ZodObject<{
         dimensions: z.ZodRecord<z.ZodString, z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+export declare const entitlementHistoryWindow: z.ZodObject<{
+    period: z.ZodObject<{
+        from: z.ZodDate;
+        to: z.ZodDate;
+    }, z.core.$strip>;
+    usage: z.ZodString;
+    balanceAtStart: z.ZodString;
+}, z.core.$strip>;
+export declare const entitlementBurndownSegment: z.ZodObject<{
+    period: z.ZodObject<{
+        from: z.ZodDate;
+        to: z.ZodDate;
+    }, z.core.$strip>;
+    usage: z.ZodString;
+    overage: z.ZodString;
+    balance: z.ZodObject<{
+        start: z.ZodString;
+        end: z.ZodString;
+    }, z.core.$strip>;
+    grantBalances: z.ZodObject<{
+        start: z.ZodRecord<z.ZodString, z.ZodString>;
+        end: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strip>;
+    grantUsages: z.ZodArray<z.ZodObject<{
+        grantId: z.ZodString;
+        usage: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const chargeRealizationDetailedLineFlatFee: z.ZodObject<{
     id: z.ZodString;
     createdAt: z.ZodDate;
@@ -3937,6 +3978,36 @@ export declare const ingestedEventPaginatedResponse: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+export declare const entitlementHistory: z.ZodObject<{
+    windowedHistory: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodDate;
+            to: z.ZodDate;
+        }, z.core.$strip>;
+        usage: z.ZodString;
+        balanceAtStart: z.ZodString;
+    }, z.core.$strip>>;
+    burndownHistory: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodDate;
+            to: z.ZodDate;
+        }, z.core.$strip>;
+        usage: z.ZodString;
+        overage: z.ZodString;
+        balance: z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        grantBalances: z.ZodObject<{
+            start: z.ZodRecord<z.ZodString, z.ZodString>;
+            end: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>;
+        grantUsages: z.ZodArray<z.ZodObject<{
+            grantId: z.ZodString;
+            usage: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const chargeRealizationDetailedLine: z.ZodDiscriminatedUnion<[z.ZodObject<{
     id: z.ZodString;
     createdAt: z.ZodDate;
@@ -18321,6 +18392,46 @@ export declare const createCustomerEntitlementResponse: z.ZodDiscriminatedUnion<
     updatedAt: z.ZodDate;
     deletedAt: z.ZodOptional<z.ZodDate>;
 }, z.core.$strip>], "type">;
+export declare const getCustomerEntitlementHistoryPathParams: z.ZodObject<{
+    customerId: z.ZodString;
+    entitlementId: z.ZodString;
+}, z.core.$strip>;
+export declare const getCustomerEntitlementHistoryQueryParams: z.ZodObject<{
+    from: z.ZodOptional<z.ZodDate>;
+    to: z.ZodOptional<z.ZodDate>;
+    windowSize: z.ZodUnion<readonly [z.ZodLiteral<"PT1H">, z.ZodLiteral<"P1D">]>;
+    timeZone: z.ZodDefault<z.ZodOptional<z.ZodCoercedString<unknown>>>;
+}, z.core.$strip>;
+export declare const getCustomerEntitlementHistoryResponse: z.ZodObject<{
+    windowedHistory: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodDate;
+            to: z.ZodDate;
+        }, z.core.$strip>;
+        usage: z.ZodString;
+        balanceAtStart: z.ZodString;
+    }, z.core.$strip>>;
+    burndownHistory: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodDate;
+            to: z.ZodDate;
+        }, z.core.$strip>;
+        usage: z.ZodString;
+        overage: z.ZodString;
+        balance: z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        grantBalances: z.ZodObject<{
+            start: z.ZodRecord<z.ZodString, z.ZodString>;
+            end: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>;
+        grantUsages: z.ZodArray<z.ZodObject<{
+            grantId: z.ZodString;
+            usage: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const createCreditGrantPathParams: z.ZodObject<{
     customerId: z.ZodString;
 }, z.core.$strip>;
@@ -33353,6 +33464,7 @@ export declare const entitlementMeasureUsageFromPresetWire: z.ZodEnum<{
     current_period_start: "current_period_start";
     now: "now";
 }>;
+export declare const entitlementHistoryWindowSizeWire: z.ZodUnion<readonly [z.ZodLiteral<"PT1H">, z.ZodLiteral<"P1D">]>;
 export declare const createLabelsWire: z.ZodRecord<z.ZodString, z.ZodString>;
 export declare const creditFundingMethodWire: z.ZodEnum<{
     external: "external";
@@ -33814,6 +33926,14 @@ export declare const entitlementIssueAfterResetWire: z.ZodObject<{
     amount: z.ZodString;
     priority: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strict>;
+export declare const entitlementBurndownBalanceWire: z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, z.core.$strict>;
+export declare const entitlementBurndownGrantBalancesWire: z.ZodObject<{
+    start: z.ZodRecord<z.ZodString, z.ZodString>;
+    end: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strict>;
 export declare const createChargeCostBasisManualWire: z.ZodObject<{
     type: z.ZodLiteral<"manual">;
     fiat_currency: z.ZodOptional<z.ZodString>;
@@ -34034,6 +34154,10 @@ export declare const profileReferenceWire: z.ZodObject<{
 export declare const featureReferenceWire: z.ZodObject<{
     id: z.ZodString;
 }, z.core.$strict>;
+export declare const entitlementGrantUsageWire: z.ZodObject<{
+    grant_id: z.ZodString;
+    usage: z.ZodString;
+}, z.core.$strict>;
 export declare const createChargeCostBasisPinnedWire: z.ZodObject<{
     type: z.ZodLiteral<"pinned">;
     fiat_currency: z.ZodString;
@@ -35850,6 +35974,34 @@ export declare const meterQueryResultWire: z.ZodObject<{
         dimensions: z.ZodRecord<z.ZodString, z.ZodString>;
     }, z.core.$strict>>;
 }, z.core.$strict>;
+export declare const entitlementHistoryWindowWire: z.ZodObject<{
+    period: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+    }, z.core.$strict>;
+    usage: z.ZodString;
+    balance_at_start: z.ZodString;
+}, z.core.$strict>;
+export declare const entitlementBurndownSegmentWire: z.ZodObject<{
+    period: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+    }, z.core.$strict>;
+    usage: z.ZodString;
+    overage: z.ZodString;
+    balance: z.ZodObject<{
+        start: z.ZodString;
+        end: z.ZodString;
+    }, z.core.$strict>;
+    grant_balances: z.ZodObject<{
+        start: z.ZodRecord<z.ZodString, z.ZodString>;
+        end: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strict>;
+    grant_usages: z.ZodArray<z.ZodObject<{
+        grant_id: z.ZodString;
+        usage: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
 export declare const chargeRealizationDetailedLineFlatFeeWire: z.ZodObject<{
     id: z.ZodString;
     created_at: z.ZodString;
@@ -37112,6 +37264,36 @@ export declare const ingestedEventPaginatedResponseWire: z.ZodObject<{
         }, z.core.$strict>;
     }, z.core.$strict>;
 }, z.core.$strict>;
+export declare const entitlementHistoryWire: z.ZodObject<{
+    windowed_history: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+        }, z.core.$strict>;
+        usage: z.ZodString;
+        balance_at_start: z.ZodString;
+    }, z.core.$strict>>;
+    burndown_history: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+        }, z.core.$strict>;
+        usage: z.ZodString;
+        overage: z.ZodString;
+        balance: z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strict>;
+        grant_balances: z.ZodObject<{
+            start: z.ZodRecord<z.ZodString, z.ZodString>;
+            end: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strict>;
+        grant_usages: z.ZodArray<z.ZodObject<{
+            grant_id: z.ZodString;
+            usage: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
 export declare const chargeRealizationDetailedLineWire: z.ZodDiscriminatedUnion<[z.ZodObject<{
     id: z.ZodString;
     created_at: z.ZodString;
@@ -51487,6 +51669,46 @@ export declare const createCustomerEntitlementResponseWire: z.ZodDiscriminatedUn
     updated_at: z.ZodString;
     deleted_at: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>], "type">;
+export declare const getCustomerEntitlementHistoryPathParamsWire: z.ZodObject<{
+    customerId: z.ZodString;
+    entitlementId: z.ZodString;
+}, z.core.$strip>;
+export declare const getCustomerEntitlementHistoryQueryParamsWire: z.ZodObject<{
+    from: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodString>;
+    window_size: z.ZodUnion<readonly [z.ZodLiteral<"PT1H">, z.ZodLiteral<"P1D">]>;
+    time_zone: z.ZodOptional<z.ZodCoercedString<unknown>>;
+}, z.core.$strip>;
+export declare const getCustomerEntitlementHistoryResponseWire: z.ZodObject<{
+    windowed_history: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+        }, z.core.$strict>;
+        usage: z.ZodString;
+        balance_at_start: z.ZodString;
+    }, z.core.$strict>>;
+    burndown_history: z.ZodArray<z.ZodObject<{
+        period: z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+        }, z.core.$strict>;
+        usage: z.ZodString;
+        overage: z.ZodString;
+        balance: z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strict>;
+        grant_balances: z.ZodObject<{
+            start: z.ZodRecord<z.ZodString, z.ZodString>;
+            end: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strict>;
+        grant_usages: z.ZodArray<z.ZodObject<{
+            grant_id: z.ZodString;
+            usage: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
 export declare const createCreditGrantPathParamsWire: z.ZodObject<{
     customerId: z.ZodString;
 }, z.core.$strip>;

package/dist/models/schemas.js

@@ -385,6 +385,9 @@ export const iso8601Duration = z
 export const entitlementMeasureUsageFromPreset = z
     .enum(['current_period_start', 'now'])
     .describe('Preset for the time from which usage is measured. - `current_period_start`: the start of the current usage period. - `now`: the entitlement creation time.');
+export const entitlementHistoryWindowSize = z
+    .union([z.literal('PT1H'), z.literal('P1D')])
+    .describe('The meter query granularities the usage history can be grouped into. Sub-hour windows are too expensive to compute and monthly windows are not supported.');
 export const createLabels = z
     .record(z.string(), z.string())
     .describe('Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "\\_".');
@@ -1198,6 +1201,22 @@ export const entitlementIssueAfterReset = z
         .describe('The priority of the grant created after each reset. Lower values have higher priority.'),
 })
     .describe('Usage granted automatically after each reset of a metered entitlement. The balance returns to `amount` after every reset.');
+export const entitlementBurndownBalance = z
+    .object({
+    start: numeric,
+    end: numeric,
+})
+    .describe('Entitlement balance at the boundaries of a burndown segment.');
+export const entitlementBurndownGrantBalances = z
+    .object({
+    start: z
+        .record(z.string(), numeric)
+        .describe('The balance of each active grant at the start of the segment.'),
+    end: z
+        .record(z.string(), numeric)
+        .describe('The balance of each active grant at the end of the segment.'),
+})
+    .describe('Grant balances at the boundaries of a burndown segment, keyed by grant ID.');
 export const createChargeCostBasisManual = z
     .object({
     type: z
@@ -1434,6 +1453,12 @@ export const featureReference = z
     id: ulid,
 })
     .describe('Feature reference.');
+export const entitlementGrantUsage = z
+    .object({
+    grantId: ulid,
+    usage: numeric,
+})
+    .describe('Usage taken from a single grant.');
 export const createChargeCostBasisPinned = z
     .object({
     type: z
@@ -2991,6 +3016,25 @@ export const meterQueryResult = z
         .describe('The usage data. If no data is available, an empty array is returned.'),
 })
     .describe('Meter query result.');
+export const entitlementHistoryWindow = z
+    .object({
+    period: closedPeriod,
+    usage: numeric,
+    balanceAtStart: numeric,
+})
+    .describe('Usage and balance of a single history window.');
+export const entitlementBurndownSegment = z
+    .object({
+    period: closedPeriod,
+    usage: numeric,
+    overage: numeric,
+    balance: entitlementBurndownBalance,
+    grantBalances: entitlementBurndownGrantBalances,
+    grantUsages: z
+        .array(entitlementGrantUsage)
+        .describe('The grants consumed in the segment and the usage taken from each.'),
+})
+    .describe('A period in which grants were consumed in a fixed order.');
 export const chargeRealizationDetailedLineFlatFee = z
     .object({
     id: ulid,
@@ -3751,6 +3795,16 @@ export const ingestedEventPaginatedResponse = z
     meta: cursorMeta,
 })
     .describe('Cursor paginated response.');
+export const entitlementHistory = z
+    .object({
+    windowedHistory: z
+        .array(entitlementHistoryWindow)
+        .describe('Usage in half-open windows of the requested size, aligned to the requested time zone. Empty windows are included; windows before usage measurement began are omitted.'),
+    burndownHistory: z
+        .array(entitlementBurndownSegment)
+        .describe('Periods in which grants were consumed in a fixed order. A new segment starts whenever grant priorities change or a usage period starts.'),
+})
+    .describe('Balance and usage history of a metered entitlement.');
 export const chargeRealizationDetailedLine = z
     .discriminatedUnion('type', [
     chargeRealizationDetailedLineFlatFee,
@@ -5488,6 +5542,21 @@ export const createCustomerEntitlementPathParams = z.object({
 });
 export const createCustomerEntitlementBody = createEntitlementRequest;
 export const createCustomerEntitlementResponse = entitlement;
+export const getCustomerEntitlementHistoryPathParams = z.object({
+    customerId: ulid,
+    entitlementId: ulid,
+});
+export const getCustomerEntitlementHistoryQueryParams = z.object({
+    from: dateTime.optional(),
+    to: dateTime.optional(),
+    windowSize: entitlementHistoryWindowSize,
+    timeZone: z.coerce
+        .string()
+        .optional()
+        .default('UTC')
+        .describe('The IANA time zone the windows are aligned to.'),
+});
+export const getCustomerEntitlementHistoryResponse = entitlementHistory;
 export const createCreditGrantPathParams = z.object({
     customerId: ulid,
 });
@@ -6526,6 +6595,9 @@ export const iso8601DurationWire = z
 export const entitlementMeasureUsageFromPresetWire = z
     .enum(['current_period_start', 'now'])
     .describe('Preset for the time from which usage is measured. - `current_period_start`: the start of the current usage period. - `now`: the entitlement creation time.');
+export const entitlementHistoryWindowSizeWire = z
+    .union([z.literal('PT1H'), z.literal('P1D')])
+    .describe('The meter query granularities the usage history can be grouped into. Sub-hour windows are too expensive to compute and monthly windows are not supported.');
 export const createLabelsWire = z
     .record(z.string(), z.string())
     .describe('Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "\\_".');
@@ -7332,6 +7404,22 @@ export const entitlementIssueAfterResetWire = z
         .describe('The priority of the grant created after each reset. Lower values have higher priority.'),
 })
     .describe('Usage granted automatically after each reset of a metered entitlement. The balance returns to `amount` after every reset.');
+export const entitlementBurndownBalanceWire = z
+    .strictObject({
+    start: numericWire,
+    end: numericWire,
+})
+    .describe('Entitlement balance at the boundaries of a burndown segment.');
+export const entitlementBurndownGrantBalancesWire = z
+    .strictObject({
+    start: z
+        .record(z.string(), numericWire)
+        .describe('The balance of each active grant at the start of the segment.'),
+    end: z
+        .record(z.string(), numericWire)
+        .describe('The balance of each active grant at the end of the segment.'),
+})
+    .describe('Grant balances at the boundaries of a burndown segment, keyed by grant ID.');
 export const createChargeCostBasisManualWire = z
     .strictObject({
     type: z
@@ -7568,6 +7656,12 @@ export const featureReferenceWire = z
     id: ulidWire,
 })
     .describe('Feature reference.');
+export const entitlementGrantUsageWire = z
+    .strictObject({
+    grant_id: ulidWire,
+    usage: numericWire,
+})
+    .describe('Usage taken from a single grant.');
 export const createChargeCostBasisPinnedWire = z
     .strictObject({
     type: z
@@ -9105,6 +9199,25 @@ export const meterQueryResultWire = z
         .describe('The usage data. If no data is available, an empty array is returned.'),
 })
     .describe('Meter query result.');
+export const entitlementHistoryWindowWire = z
+    .strictObject({
+    period: closedPeriodWire,
+    usage: numericWire,
+    balance_at_start: numericWire,
+})
+    .describe('Usage and balance of a single history window.');
+export const entitlementBurndownSegmentWire = z
+    .strictObject({
+    period: closedPeriodWire,
+    usage: numericWire,
+    overage: numericWire,
+    balance: entitlementBurndownBalanceWire,
+    grant_balances: entitlementBurndownGrantBalancesWire,
+    grant_usages: z
+        .array(entitlementGrantUsageWire)
+        .describe('The grants consumed in the segment and the usage taken from each.'),
+})
+    .describe('A period in which grants were consumed in a fixed order.');
 export const chargeRealizationDetailedLineFlatFeeWire = z
     .strictObject({
     id: ulidWire,
@@ -9863,6 +9976,16 @@ export const ingestedEventPaginatedResponseWire = z
     meta: cursorMetaWire,
 })
     .describe('Cursor paginated response.');
+export const entitlementHistoryWire = z
+    .strictObject({
+    windowed_history: z
+        .array(entitlementHistoryWindowWire)
+        .describe('Usage in half-open windows of the requested size, aligned to the requested time zone. Empty windows are included; windows before usage measurement began are omitted.'),
+    burndown_history: z
+        .array(entitlementBurndownSegmentWire)
+        .describe('Periods in which grants were consumed in a fixed order. A new segment starts whenever grant priorities change or a usage period starts.'),
+})
+    .describe('Balance and usage history of a metered entitlement.');
 export const chargeRealizationDetailedLineWire = z
     .discriminatedUnion('type', [
     chargeRealizationDetailedLineFlatFeeWire,
@@ -11603,6 +11726,20 @@ export const createCustomerEntitlementPathParamsWire = z.object({
 });
 export const createCustomerEntitlementBodyWire = createEntitlementRequestWire;
 export const createCustomerEntitlementResponseWire = entitlementWire;
+export const getCustomerEntitlementHistoryPathParamsWire = z.object({
+    customerId: ulidWire,
+    entitlementId: ulidWire,
+});
+export const getCustomerEntitlementHistoryQueryParamsWire = z.object({
+    from: dateTimeWire.optional(),
+    to: dateTimeWire.optional(),
+    window_size: entitlementHistoryWindowSizeWire,
+    time_zone: z.coerce
+        .string()
+        .optional()
+        .describe('The IANA time zone the windows are aligned to.'),
+});
+export const getCustomerEntitlementHistoryResponseWire = entitlementHistoryWire;
 export const createCreditGrantPathParamsWire = z.object({
     customerId: ulidWire,
 });

package/dist/models/types.d.ts

@@ -632,6 +632,20 @@ export interface EntitlementIssueAfterReset {
      */
     priority: number;
 }
+/** Entitlement balance at the boundaries of a burndown segment. */
+export interface EntitlementBurndownBalance {
+    /** The balance at the start of the segment. */
+    start: string;
+    /** The balance at the end of the segment. */
+    end: string;
+}
+/** Grant balances at the boundaries of a burndown segment, keyed by grant ID. */
+export interface EntitlementBurndownGrantBalances {
+    /** The balance of each active grant at the start of the segment. */
+    start: Record<string, string>;
+    /** The balance of each active grant at the end of the segment. */
+    end: Record<string, string>;
+}
 /** Cost basis with an explicit conversion rate supplied with the charge. */
 export interface CreateChargeCostBasisManual {
     /** Discriminator selecting the cost basis mode. */
@@ -890,6 +904,13 @@ export interface ProfileReference {
 export interface FeatureReference {
     id: string;
 }
+/** Usage taken from a single grant. */
+export interface EntitlementGrantUsage {
+    /** The ID of the grant. */
+    grantId: string;
+    /** The usage taken from the grant. */
+    usage: string;
+}
 /** Cost basis pinned to a specific cost basis resource of the custom currency. */
 export interface CreateChargeCostBasisPinned {
     /** Discriminator selecting the cost basis mode. */
@@ -2932,6 +2953,33 @@ export interface MeterQueryResult {
     /** The usage data. If no data is available, an empty array is returned. */
     data: MeterQueryRow[];
 }
+/** Usage and balance of a single history window. */
+export interface EntitlementHistoryWindow {
+    /** The period the window covers. */
+    period: ClosedPeriod;
+    /** The usage recorded in the window. */
+    usage: string;
+    /** The entitlement balance at the start of the window. */
+    balanceAtStart: string;
+}
+/** A period in which grants were consumed in a fixed order. */
+export interface EntitlementBurndownSegment {
+    /** The period the segment covers. */
+    period: ClosedPeriod;
+    /** The usage recorded in the segment. */
+    usage: string;
+    /** The usage in the segment not covered by any grant. */
+    overage: string;
+    /** The entitlement balance at the start and at the end of the segment. */
+    balance: EntitlementBurndownBalance;
+    /**
+     * The balance of each active grant at the start and at the end of the segment,
+     * keyed by grant ID.
+     */
+    grantBalances: EntitlementBurndownGrantBalances;
+    /** The grants consumed in the segment and the usage taken from each. */
+    grantUsages: EntitlementGrantUsage[];
+}
 /** A detailed line produced by a flat fee charge's realization run. */
 export interface ChargeRealizationDetailedLineFlatFee {
     id: string;
@@ -4009,6 +4057,20 @@ export interface IngestedEventPaginatedResponse {
     data: IngestedEvent[];
     meta: CursorMeta;
 }
+/** Balance and usage history of a metered entitlement. */
+export interface EntitlementHistory {
+    /**
+     * Usage in half-open windows of the requested size, aligned to the requested time
+     * zone. Empty windows are included; windows before usage measurement began are
+     * omitted.
+     */
+    windowedHistory: EntitlementHistoryWindow[];
+    /**
+     * Periods in which grants were consumed in a fixed order. A new segment starts
+     * whenever grant priorities change or a usage period starts.
+     */
+    burndownHistory: EntitlementBurndownSegment[];
+}
 /** The list of parameters that failed validation. */
 export type InvalidParameters = InvalidParameter[];
 /** A meter query request. */
@@ -6579,6 +6641,11 @@ export type MeterAggregation = 'sum' | 'count' | 'unique_count' | 'avg' | 'min'
  * format.
  */
 export type MeterQueryGranularity = 'PT1M' | 'PT1H' | 'P1D' | 'P1M';
+/**
+ * The meter query granularities the usage history can be grouped into. Sub-hour
+ * windows are too expensive to compute and monthly windows are not supported.
+ */
+export type EntitlementHistoryWindowSize = 'PT1H' | 'P1D';
 /**
  * Filters on the given string field value by exact match. All properties are
  * optional; provide exactly one to specify the comparison.

package/dist/sdk/entitlements.d.ts

@@ -1,6 +1,6 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse, GetCustomerEntitlementAccessRequest, GetCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
+import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
 export declare class Entitlements {
     private readonly _client;
     constructor(_client: Client);
@@ -10,12 +10,4 @@ export declare class Entitlements {
      * GET /openmeter/customers/{customerId}/entitlement-access
      */
     listCustomerAccess(request: ListCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<ListCustomerEntitlementAccessResponse>;
-    /**
-     * Get customer entitlement access
-     *
-     * Get the customer's access to a single feature.
-     *
-     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
-     */
-    getCustomerAccess(request: GetCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<GetCustomerEntitlementAccessResponse>;
 }

package/dist/sdk/entitlements.js

@@ -1,6 +1,6 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
-import { listCustomerEntitlementAccess, getCustomerEntitlementAccess, } from '../funcs/entitlements.js';
+import { listCustomerEntitlementAccess } from '../funcs/entitlements.js';
 export class Entitlements {
     _client;
     constructor(_client) {
@@ -14,14 +14,4 @@ export class Entitlements {
     async listCustomerAccess(request, options) {
         return unwrap(await listCustomerEntitlementAccess(this._client, request, options));
     }
-    /**
-     * Get customer entitlement access
-     *
-     * Get the customer's access to a single feature.
-     *
-     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
-     */
-    async getCustomerAccess(request, options) {
-        return unwrap(await getCustomerEntitlementAccess(this._client, request, options));
-    }
 }

package/dist/sdk/internal.d.ts

@@ -1,6 +1,7 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+import type { CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, GetCustomerEntitlementHistoryRequest, GetCustomerEntitlementHistoryResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
+import type { GetCustomerEntitlementAccessRequest, GetCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
 import type { UnscheduleSubscriptionRequest, UnscheduleSubscriptionResponse, RestoreSubscriptionRequest, RestoreSubscriptionResponse, MigrateSubscriptionRequest, MigrateSubscriptionResponse, CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse, UpdateSubscriptionAddonRequest, UpdateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
 import type { UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.js';
 import type { ListInvoicesRequest, ListInvoicesResponse, GetInvoiceRequest, GetInvoiceResponse, UpdateInvoiceRequest, UpdateInvoiceResponse, DeleteInvoiceRequest, DeleteInvoiceResponse, AdvanceInvoiceRequest, AdvanceInvoiceResponse, ApproveInvoiceRequest, ApproveInvoiceResponse, RetryInvoiceRequest, RetryInvoiceResponse, SnapshotQuantitiesInvoiceRequest, SnapshotQuantitiesInvoiceResponse } from '../models/operations/invoices.js';
@@ -19,6 +20,8 @@ export declare class Internal {
     constructor(_client: Client);
     private _customers?;
     get customers(): InternalCustomers;
+    private _entitlements?;
+    get entitlements(): InternalEntitlements;
     private _subscriptions?;
     get subscriptions(): InternalSubscriptions;
     private _apps?;
@@ -59,6 +62,20 @@ export declare class InternalCustomersEntitlements {
      * POST /openmeter/customers/{customerId}/entitlements
      */
     create(request: CreateCustomerEntitlementRequest, options?: RequestOptions): Promise<CreateCustomerEntitlementResponse>;
+    /**
+     * Get customer entitlement history
+     *
+     * Get the balance and usage history of a metered entitlement. The queried range
+     * may span multiple usage periods.
+     *
+     * `windowed_history` groups usage into windows of the requested size and reports
+     * the balance at the start of each window. `burndown_history` lists the periods in
+     * which grants were consumed in a fixed order, together with the usage taken from
+     * each grant.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
+     */
+    getHistory(request: GetCustomerEntitlementHistoryRequest, options?: RequestOptions): Promise<GetCustomerEntitlementHistoryResponse>;
 }
 export declare class InternalCustomersCredits {
     private readonly _client;
@@ -122,6 +139,18 @@ export declare class InternalCustomersCharges {
      */
     create(request: CreateCustomerChargesRequest, options?: RequestOptions): Promise<CreateCustomerChargesResponse>;
 }
+export declare class InternalEntitlements {
+    private readonly _client;
+    constructor(_client: Client);
+    /**
+     * Get customer entitlement access
+     *
+     * Get the customer's access to a single feature.
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
+     */
+    getCustomerAccess(request: GetCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<GetCustomerEntitlementAccessResponse>;
+}
 export declare class InternalSubscriptions {
     private readonly _client;
     constructor(_client: Client);

package/dist/sdk/internal.js

@@ -1,7 +1,8 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { paginatePages } from '../lib/paginate.js';
-import { createCustomerEntitlement, voidCreditGrant, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
+import { createCustomerEntitlement, getCustomerEntitlementHistory, voidCreditGrant, listCustomerCharges, createCustomerCharges, } from '../funcs/customers.js';
+import { getCustomerEntitlementAccess } from '../funcs/entitlements.js';
 import { unscheduleSubscription, restoreSubscription, migrateSubscription, createSubscriptionAddon, updateSubscriptionAddon, } from '../funcs/subscriptions.js';
 import { uninstallApp, updateApp, listAppCatalog, getAppCatalogItem, installApp, } from '../funcs/apps.js';
 import { listInvoices, getInvoice, updateInvoice, deleteInvoice, advanceInvoice, approveInvoice, retryInvoice, snapshotQuantitiesInvoice, } from '../funcs/invoices.js';
@@ -23,6 +24,10 @@ export class Internal {
     get customers() {
         return (this._customers ??= new InternalCustomers(this._client));
     }
+    _entitlements;
+    get entitlements() {
+        return (this._entitlements ??= new InternalEntitlements(this._client));
+    }
     _subscriptions;
     get subscriptions() {
         return (this._subscriptions ??= new InternalSubscriptions(this._client));
@@ -89,6 +94,22 @@ export class InternalCustomersEntitlements {
     async create(request, options) {
         return unwrap(await createCustomerEntitlement(this._client, request, options));
     }
+    /**
+     * Get customer entitlement history
+     *
+     * Get the balance and usage history of a metered entitlement. The queried range
+     * may span multiple usage periods.
+     *
+     * `windowed_history` groups usage into windows of the requested size and reports
+     * the balance at the start of each window. `burndown_history` lists the periods in
+     * which grants were consumed in a fixed order, together with the usage taken from
+     * each grant.
+     *
+     * GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
+     */
+    async getHistory(request, options) {
+        return unwrap(await getCustomerEntitlementHistory(this._client, request, options));
+    }
 }
 export class InternalCustomersCredits {
     _client;
@@ -168,6 +189,22 @@ export class InternalCustomersCharges {
         return unwrap(await createCustomerCharges(this._client, request, options));
     }
 }
+export class InternalEntitlements {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Get customer entitlement access
+     *
+     * Get the customer's access to a single feature.
+     *
+     * GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
+     */
+    async getCustomerAccess(request, options) {
+        return unwrap(await getCustomerEntitlementAccess(this._client, request, options));
+    }
+}
 export class InternalSubscriptions {
     _client;
     constructor(_client) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-89ad46498d71",
+  "version": "1.0.0-beta-2b50cff9e992",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",