@openmeter/client 1.0.0-beta-84bb9e2fb342 → 1.0.0-beta-4ffb0202fcfc

package/dist/models/schemas.js

@@ -2598,6 +2598,30 @@ export const workflowCollectionAlignmentAnchored = z
     recurring_period: recurringPeriod,
 })
     .describe('BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items into an invoice.');
+export const chargeFlatFeeSystemIntent = z
+    .object({
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    labels: labels.optional(),
+    invoice_at: dateTime,
+    service_period: closedPeriod,
+    full_service_period: closedPeriod,
+    billing_period: closedPeriod,
+    payment_term: pricePaymentTerm,
+    discounts: chargeFlatFeeDiscounts.optional(),
+    proration_configuration: rateCardProrationConfiguration,
+    amount_before_proration: currencyAmount,
+    deleted_at: dateTime.optional(),
+})
+    .describe('Flat fee intent fields from the system lifecycle controller shadowed by a manual override.');
 export const subscriptionPagePaginatedResponse = z
     .object({
     data: z.array(subscription),
@@ -3379,11 +3403,11 @@ export const chargeFlatFee = z
     proration_configuration: rateCardProrationConfiguration,
     amount_after_proration: currencyAmount,
     price: price,
+    system_intent: chargeFlatFeeSystemIntent.optional(),
 })
     .describe('A flat fee charge for a customer.');
-export const chargeUsageBased = z
+export const chargeUsageBasedSystemIntent = z
     .object({
-    id: ulid,
     name: z
         .string()
         .min(1)
@@ -3395,32 +3419,15 @@ export const chargeUsageBased = z
         .optional()
         .describe('Optional description of the resource. Maximum 1024 characters.'),
     labels: labels.optional(),
-    created_at: dateTime,
-    updated_at: dateTime,
-    deleted_at: dateTime.optional(),
-    type: z.literal('usage_based').describe('The type of the charge.'),
-    customer: billingCustomerReference,
-    lifecycle_controller: lifecycleController,
-    subscription: subscriptionReference.optional(),
-    currency: currencyCode,
-    status: chargeStatus,
     invoice_at: dateTime,
     service_period: closedPeriod,
     full_service_period: closedPeriod,
     billing_period: closedPeriod,
-    advance_after: dateTime.optional(),
-    unique_reference_id: z
-        .string()
-        .optional()
-        .describe('Unique reference ID of the charge.'),
-    settlement_mode: settlementMode,
-    tax_config: taxConfig.optional(),
     discounts: rateCardDiscounts.optional(),
-    feature_key: z.string().describe('The feature associated with the charge.'),
-    totals: chargeTotals,
     price: price,
+    deleted_at: dateTime.optional(),
 })
-    .describe('A usage-based charge for a customer.');
+    .describe('Usage-based intent fields from the system lifecycle controller shadowed by a manual override.');
 export const createChargeUsageBasedRequest = z
     .object({
     name: z
@@ -3498,9 +3505,47 @@ export const workflow = z
     tax: workflowTaxSettings.optional(),
 })
     .describe('Billing workflow settings.');
-export const charge = z
-    .discriminatedUnion('type', [chargeFlatFee, chargeUsageBased])
-    .describe('Customer charge.');
+export const chargeUsageBased = z
+    .object({
+    id: ulid,
+    name: z
+        .string()
+        .min(1)
+        .max(256)
+        .describe('Display name of the resource. Between 1 and 256 characters.'),
+    description: z
+        .string()
+        .max(1024)
+        .optional()
+        .describe('Optional description of the resource. Maximum 1024 characters.'),
+    labels: labels.optional(),
+    created_at: dateTime,
+    updated_at: dateTime,
+    deleted_at: dateTime.optional(),
+    type: z.literal('usage_based').describe('The type of the charge.'),
+    customer: billingCustomerReference,
+    lifecycle_controller: lifecycleController,
+    subscription: subscriptionReference.optional(),
+    currency: currencyCode,
+    status: chargeStatus,
+    invoice_at: dateTime,
+    service_period: closedPeriod,
+    full_service_period: closedPeriod,
+    billing_period: closedPeriod,
+    advance_after: dateTime.optional(),
+    unique_reference_id: z
+        .string()
+        .optional()
+        .describe('Unique reference ID of the charge.'),
+    settlement_mode: settlementMode,
+    tax_config: taxConfig.optional(),
+    discounts: rateCardDiscounts.optional(),
+    feature_key: z.string().describe('The feature associated with the charge.'),
+    totals: chargeTotals,
+    price: price,
+    system_intent: chargeUsageBasedSystemIntent.optional(),
+})
+    .describe('A usage-based charge for a customer.');
 export const createChargeRequest = z
     .discriminatedUnion('type', [
     createChargeFlatFeeRequest,
@@ -3702,12 +3747,9 @@ export const upsertBillingProfileRequest = z
     default: z.boolean().describe('Whether this is the default profile.'),
 })
     .describe('BillingProfile upsert request.');
-export const chargePagePaginatedResponse = z
-    .object({
-    data: z.array(charge),
-    meta: paginatedMeta,
-})
-    .describe('Page paginated response.');
+export const charge = z
+    .discriminatedUnion('type', [chargeFlatFee, chargeUsageBased])
+    .describe('Customer charge.');
 export const subscriptionAddon = z
     .object({
     id: ulid,
@@ -3853,6 +3895,12 @@ export const profilePagePaginatedResponse = z
     meta: paginatedMeta,
 })
     .describe('Page paginated response.');
+export const chargePagePaginatedResponse = z
+    .object({
+    data: z.array(charge),
+    meta: paginatedMeta,
+})
+    .describe('Page paginated response.');
 export const subscriptionAddonPagePaginatedResponse = z
     .object({
     data: z.array(subscriptionAddon),

package/dist/models/types.d.ts

@@ -2982,6 +2982,46 @@ export interface WorkflowCollectionAlignmentAnchored {
     /** The recurring period for the alignment. */
     recurring_period: RecurringPeriod;
 }
+/**
+ * Flat fee intent fields from the system lifecycle controller shadowed by a manual
+ * override.
+ */
+export interface ChargeFlatFeeSystemIntent {
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** The timestamp when the charge is intended to be invoiced. */
+    invoice_at: string;
+    /** The effective service period covered by the charge. */
+    service_period: ClosedPeriod;
+    /** The full, unprorated service period of the charge. */
+    full_service_period: ClosedPeriod;
+    /** The billing period the charge belongs to. */
+    billing_period: ClosedPeriod;
+    /** Payment term of the flat fee charge. */
+    payment_term: 'in_advance' | 'in_arrears';
+    /** The discounts applied to the charge. */
+    discounts?: ChargeFlatFeeDiscounts;
+    /** The proration configuration of the charge. */
+    proration_configuration: RateCardProrationConfiguration;
+    /** The amount before proration of the system lifecycle controller flat fee intent. */
+    amount_before_proration: CurrencyAmount;
+    /**
+     * The timestamp when the system lifecycle controller intent was deleted. The
+     * effective charge can remain visible while a manual override is active.
+     */
+    deleted_at?: string;
+}
 /** Page paginated response. */
 export interface SubscriptionPagePaginatedResponse {
     data: Subscription[];
@@ -4123,10 +4163,18 @@ export interface ChargeFlatFee {
     amount_after_proration: CurrencyAmount;
     /** The price of the charge. */
     price: PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
+    /**
+     * Current intent from the system lifecycle controller for a charge that has an
+     * active manual override. The top-level charge fields remain the effective
+     * customer-facing intent.
+     */
+    system_intent?: ChargeFlatFeeSystemIntent;
 }
-/** A usage-based charge for a customer. */
-export interface ChargeUsageBased {
-    id: string;
+/**
+ * Usage-based intent fields from the system lifecycle controller shadowed by a
+ * manual override.
+ */
+export interface ChargeUsageBasedSystemIntent {
     /**
      * Display name of the resource.
      *
@@ -4140,30 +4188,6 @@ export interface ChargeUsageBased {
      */
     description?: string;
     labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    created_at: string;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updated_at: string;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deleted_at?: string;
-    /** The type of the charge. */
-    type: 'usage_based';
-    /** The customer owning the charge. */
-    customer: BillingCustomerReference;
-    /**
-     * Indicates whether the charge lifecycle is controlled by OpenMeter or manually
-     * overridden by the API user.
-     */
-    lifecycle_controller: 'system' | 'manual';
-    /**
-     * The subscription that originated the charge, when the charge was created from a
-     * subscription item.
-     */
-    subscription?: SubscriptionReference;
-    /** The currency of the charge. */
-    currency: string;
-    /** The lifecycle status of the charge. */
-    status: 'created' | 'active' | 'final' | 'deleted';
     /** The timestamp when the charge is intended to be invoiced. */
     invoice_at: string;
     /** The effective service period covered by the charge. */
@@ -4172,25 +4196,15 @@ export interface ChargeUsageBased {
     full_service_period: ClosedPeriod;
     /** The billing period the charge belongs to. */
     billing_period: ClosedPeriod;
-    /**
-     * The earliest time when the charge should be advanced again by background
-     * processing.
-     */
-    advance_after?: string;
-    /** Unique reference ID of the charge. */
-    unique_reference_id?: string;
-    /** Settlement mode of the charge. */
-    settlement_mode: 'credit_then_invoice' | 'credit_only';
-    /** Tax configuration of the charge. */
-    tax_config?: TaxConfig;
     /** Discounts applied to the usage-based charge. */
     discounts?: RateCardDiscounts;
-    /** The feature associated with the charge. */
-    feature_key: string;
-    /** Aggregated booked and realtime totals for the charge. */
-    totals: ChargeTotals;
     /** The price of the charge. */
     price: PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
+    /**
+     * The timestamp when the system lifecycle controller intent was deleted. The
+     * effective charge can remain visible while a manual override is active.
+     */
+    deleted_at?: string;
 }
 /** Usage-based charge create request. */
 export interface CreateChargeUsageBasedRequest {
@@ -4315,6 +4329,80 @@ export interface Workflow {
     /** The tax settings for this workflow */
     tax?: WorkflowTaxSettings;
 }
+/** A usage-based charge for a customer. */
+export interface ChargeUsageBased {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    created_at: string;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updated_at: string;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deleted_at?: string;
+    /** The type of the charge. */
+    type: 'usage_based';
+    /** The customer owning the charge. */
+    customer: BillingCustomerReference;
+    /**
+     * Indicates whether the charge lifecycle is controlled by OpenMeter or manually
+     * overridden by the API user.
+     */
+    lifecycle_controller: 'system' | 'manual';
+    /**
+     * The subscription that originated the charge, when the charge was created from a
+     * subscription item.
+     */
+    subscription?: SubscriptionReference;
+    /** The currency of the charge. */
+    currency: string;
+    /** The lifecycle status of the charge. */
+    status: 'created' | 'active' | 'final' | 'deleted';
+    /** The timestamp when the charge is intended to be invoiced. */
+    invoice_at: string;
+    /** The effective service period covered by the charge. */
+    service_period: ClosedPeriod;
+    /** The full, unprorated service period of the charge. */
+    full_service_period: ClosedPeriod;
+    /** The billing period the charge belongs to. */
+    billing_period: ClosedPeriod;
+    /**
+     * The earliest time when the charge should be advanced again by background
+     * processing.
+     */
+    advance_after?: string;
+    /** Unique reference ID of the charge. */
+    unique_reference_id?: string;
+    /** Settlement mode of the charge. */
+    settlement_mode: 'credit_then_invoice' | 'credit_only';
+    /** Tax configuration of the charge. */
+    tax_config?: TaxConfig;
+    /** Discounts applied to the usage-based charge. */
+    discounts?: RateCardDiscounts;
+    /** The feature associated with the charge. */
+    feature_key: string;
+    /** Aggregated booked and realtime totals for the charge. */
+    totals: ChargeTotals;
+    /** The price of the charge. */
+    price: PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
+    /**
+     * Current intent from the system lifecycle controller for a charge that has an
+     * active manual override. The top-level charge fields remain the effective
+     * customer-facing intent.
+     */
+    system_intent?: ChargeUsageBasedSystemIntent;
+}
 /** A rate card for a subscription add-on. */
 export interface SubscriptionAddonRateCard {
     /** The rate card. */
@@ -4611,11 +4699,6 @@ export interface UpsertBillingProfileRequest {
     /** Whether this is the default profile. */
     default: boolean;
 }
-/** Page paginated response. */
-export interface ChargePagePaginatedResponse {
-    data: (ChargeFlatFee | ChargeUsageBased)[];
-    meta: PaginatedMeta;
-}
 /** Addon purchased with a subscription. */
 export interface SubscriptionAddon {
     id: string;
@@ -4803,6 +4886,11 @@ export interface ProfilePagePaginatedResponse {
     meta: PaginatedMeta;
 }
 /** Page paginated response. */
+export interface ChargePagePaginatedResponse {
+    data: (ChargeFlatFee | ChargeUsageBased)[];
+    meta: PaginatedMeta;
+}
+/** Page paginated response. */
 export interface SubscriptionAddonPagePaginatedResponse {
     data: SubscriptionAddon[];
     meta: PaginatedMeta;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-84bb9e2fb342",
+  "version": "1.0.0-beta-4ffb0202fcfc",
   "license": "Apache-2.0",
   "homepage": "https://openmeter.io",
   "repository": {