@paygentic/sdk 0.7.20 → 0.8.0

package/src/models/meteredentitlementdetail.ts

@@ -78,23 +78,27 @@ export type MeteredEntitlementDetail = {
    */
   isSoftLimit: boolean;
   /**
-   * Remaining grant balance for the current period.
+   * Remaining balance for the current period. When `pricingUnitId` is set, this is expressed in that pricing unit's credits (a balance shared across every feature drawing the same unit); otherwise it is in the feature's native metered units.
    */
   balance: number;
   /**
-   * Total usage consumed in the current billing period.
+   * Total usage consumed in the current billing period, in the same unit as `balance` (credits when `pricingUnitId` is set, otherwise native metered units). When `pricingUnitId` is set, this is the shared-pool aggregate across every feature drawing the same unit, not usage specific to this feature.
    */
   usageInPeriod: number;
   /**
-   * Amount of usage exceeding the granted balance.
+   * Amount of usage exceeding the balance, in the same unit as `balance` (credits when `pricingUnitId` is set, otherwise native metered units).
    */
   overage: number;
   /**
-   * Start of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.
+   * The pricing unit this feature is denominated in when it draws a credit pool. When set, `balance`/`usageInPeriod`/`overage` are in that unit's credits and reflect a balance shared across all features on the same unit. `null` for currency-denominated features (native metered units).
+   */
+  pricingUnitId: string | null;
+  /**
+   * Start of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.
    */
   currentPeriodStart: Date | null;
   /**
-   * End of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.
+   * End of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.
    */
   currentPeriodEnd: Date | null;
 };
@@ -130,6 +134,7 @@ export const MeteredEntitlementDetail$inboundSchema: z.ZodType<
   balance: z.number(),
   usageInPeriod: z.number(),
   overage: z.number(),
+  pricingUnitId: z.nullable(z.string()),
   currentPeriodStart: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),

package/src/models/meteredentitlementlistitem.ts

@@ -69,23 +69,27 @@ export type MeteredEntitlementListItem = {
    */
   isSoftLimit: boolean;
   /**
-   * Remaining grant balance for the current period.
+   * Remaining balance for the current period. When `pricingUnitId` is set, this is expressed in that pricing unit's credits (a balance shared across every feature drawing the same unit); otherwise it is in the feature's native metered units.
    */
   balance: number;
   /**
-   * Total usage consumed in the current billing period.
+   * Total usage consumed in the current billing period, in the same unit as `balance` (credits when `pricingUnitId` is set, otherwise native metered units). When `pricingUnitId` is set, this is the shared-pool aggregate across every feature drawing the same unit, not usage specific to this feature.
    */
   usageInPeriod: number;
   /**
-   * Amount of usage exceeding the granted balance.
+   * Amount of usage exceeding the balance, in the same unit as `balance` (credits when `pricingUnitId` is set, otherwise native metered units).
    */
   overage: number;
   /**
-   * Start of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.
+   * The pricing unit this feature is denominated in when it draws a credit pool. When set, `balance`/`usageInPeriod`/`overage` are in that unit's credits and reflect a balance shared across all features on the same unit. `null` for currency-denominated features (native metered units).
+   */
+  pricingUnitId: string | null;
+  /**
+   * Start of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.
    */
   currentPeriodStart: Date | null;
   /**
-   * End of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.
+   * End of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.
    */
   currentPeriodEnd: Date | null;
 };
@@ -115,6 +119,7 @@ export const MeteredEntitlementListItem$inboundSchema: z.ZodType<
   balance: z.number(),
   usageInPeriod: z.number(),
   overage: z.number(),
+  pricingUnitId: z.nullable(z.string()),
   currentPeriodStart: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),

package/src/models/operations/createplan.ts

@@ -49,14 +49,14 @@ export const CreatePlanTaxBehavior = {
 export type CreatePlanTaxBehavior = ClosedEnum<typeof CreatePlanTaxBehavior>;
 
 /**
- * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
+ * Billing engine version. Only 1 (Standard, line-item billing with metered usage support) is accepted for new plans; omitting the field defaults to 1. 0 (Legacy, fee-schedule billing) is rejected — it exists only on plans created before this restriction.
  */
 export const BillingVersion = {
   Zero: 0,
   One: 1,
 } as const;
 /**
- * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
+ * Billing engine version. Only 1 (Standard, line-item billing with metered usage support) is accepted for new plans; omitting the field defaults to 1. 0 (Legacy, fee-schedule billing) is rejected — it exists only on plans created before this restriction.
  */
 export type BillingVersion = ClosedEnum<typeof BillingVersion>;
 
@@ -118,7 +118,7 @@ export type CreatePlanRequest = {
    */
   renewalReminderDays?: number | undefined;
   /**
-   * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
+   * Billing engine version. Only 1 (Standard, line-item billing with metered usage support) is accepted for new plans; omitting the field defaults to 1. 0 (Legacy, fee-schedule billing) is rejected — it exists only on plans created before this restriction.
    */
   billingVersion?: BillingVersion | undefined;
   /**
@@ -187,7 +187,7 @@ export const CreatePlanRequest$outboundSchema: z.ZodType<
   taxBehavior: CreatePlanTaxBehavior$outboundSchema.default("exclusive"),
   renewalReminderEnabled: z.boolean().default(true),
   renewalReminderDays: z.number().int().default(3),
-  billingVersion: BillingVersion$outboundSchema.default(0),
+  billingVersion: BillingVersion$outboundSchema.default(1),
   billingAnchor: z.nullable(z.date().transform(v => v.toISOString()))
     .optional(),
 });

package/src/models/operations/createprice.ts

@@ -6,20 +6,6 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 import * as models from "../index.js";
 
-/**
- * Pricing calculation model. Required for billable metrics, optional for fees (defaults to 'standard').
- */
-export const CreatePriceModel = {
-  Standard: "standard",
-  Dynamic: "dynamic",
-  Volume: "volume",
-  Percentage: "percentage",
-} as const;
-/**
- * Pricing calculation model. Required for billable metrics, optional for fees (defaults to 'standard').
- */
-export type CreatePriceModel = ClosedEnum<typeof CreatePriceModel>;
-
 /**
  * Billing timing preference. For billable metrics: 'instant' (charges immediately) or 'in_arrears' (charges at period end). For fees: 'in_advance' (charges upfront) or 'in_arrears' (charges at period end).
  */
@@ -43,9 +29,13 @@ export type CreatePriceRequest = {
    */
   feeId?: string | undefined;
   /**
-   * Pricing calculation model. Required for billable metrics, optional for fees (defaults to 'standard').
+   * Unique identifier for a pricing unit
+   */
+  pricingUnitId?: string | undefined;
+  /**
+   * Pricing calculation model. Required for billable metrics, optional for fees (defaults to 'standard'). Only 'standard' is accepted; for percentage/revenue-share use 'standard' with a unit-price multiplier. Legacy prices using 'dynamic'/'volume'/'percentage' stay readable and billable but cannot be created.
    */
-  model?: CreatePriceModel | undefined;
+  model?: models.PriceModelInput | undefined;
   /**
    * Line item label shown on customer invoices. Sample values: 'Claude Token Consumption', 'Storage Usage (GB)', 'Inference API Calls', 'Image Generation Count', 'Training Compute Hours', 'Data Transfer (TB)'
    */
@@ -70,11 +60,6 @@ export type CreatePriceRequest = {
   quantity?: number | undefined;
 };
 
-/** @internal */
-export const CreatePriceModel$outboundSchema: z.ZodNativeEnum<
-  typeof CreatePriceModel
-> = z.nativeEnum(CreatePriceModel);
-
 /** @internal */
 export const CreatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
   typeof CreatePricePaymentTerm
@@ -84,6 +69,7 @@ export const CreatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
 export type CreatePriceRequest$Outbound = {
   billableMetricId?: string | undefined;
   feeId?: string | undefined;
+  pricingUnitId?: string | undefined;
   model?: string | undefined;
   invoiceDisplayName: string;
   paymentTerm: string;
@@ -102,7 +88,8 @@ export const CreatePriceRequest$outboundSchema: z.ZodType<
 > = z.object({
   billableMetricId: z.string().optional(),
   feeId: z.string().optional(),
-  model: CreatePriceModel$outboundSchema.optional(),
+  pricingUnitId: z.string().optional(),
+  model: models.PriceModelInput$outboundSchema.optional(),
   invoiceDisplayName: z.string(),
   paymentTerm: CreatePricePaymentTerm$outboundSchema,
   billingCadence: z.nullable(z.string()).optional(),

package/src/models/operations/updateprice.ts

@@ -7,20 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
 import * as models from "../index.js";
 
-/**
- * The pricing model to be used, which can be standard, dynamic, volume-based, or percentage-based.
- */
-export const UpdatePriceModel = {
-  Standard: "standard",
-  Dynamic: "dynamic",
-  Volume: "volume",
-  Percentage: "percentage",
-} as const;
-/**
- * The pricing model to be used, which can be standard, dynamic, volume-based, or percentage-based.
- */
-export type UpdatePriceModel = ClosedEnum<typeof UpdatePriceModel>;
-
 /**
  * Billing timing preference. For billable metrics: 'instant' (charges immediately) or 'in_arrears' (charges at period end). For fees: 'in_advance' (charges upfront) or 'in_arrears' (charges at period end).
  */
@@ -39,14 +25,18 @@ export type UpdatePriceRequestBody = {
    * Unique identifier for a billable metric
    */
   billableMetricId?: string | undefined;
+  /**
+   * Denominate this metered price in a pricing unit (credits). Set to a pricing unit ID to draw down a credit pool, null to revert to real currency, or omit to leave unchanged.
+   */
+  pricingUnitId?: string | null | undefined;
   /**
    * Updated invoice line item label. Sample values: 'LLM Token Usage', 'Storage Charges', 'API Call Fees'
    */
   invoiceDisplayName?: string | undefined;
   /**
-   * The pricing model to be used, which can be standard, dynamic, volume-based, or percentage-based.
+   * The pricing model to set. Only 'standard' is accepted. Legacy 'dynamic'/'volume'/'percentage' prices can still be edited (other fields) but cannot be switched to those models. Percentage/revenue-share is expressed via 'standard' with a unit-price multiplier.
    */
-  model?: UpdatePriceModel | undefined;
+  model?: models.PriceModelInput | undefined;
   properties?: models.PricePropertiesUnion | undefined;
   /**
    * Billing timing preference. For billable metrics: 'instant' (charges immediately) or 'in_arrears' (charges at period end). For fees: 'in_advance' (charges upfront) or 'in_arrears' (charges at period end).
@@ -78,11 +68,6 @@ export type UpdatePriceRequest = {
   requestBody: UpdatePriceRequestBody;
 };
 
-/** @internal */
-export const UpdatePriceModel$outboundSchema: z.ZodNativeEnum<
-  typeof UpdatePriceModel
-> = z.nativeEnum(UpdatePriceModel);
-
 /** @internal */
 export const UpdatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
   typeof UpdatePricePaymentTerm
@@ -91,6 +76,7 @@ export const UpdatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
 /** @internal */
 export type UpdatePriceRequestBody$Outbound = {
   billableMetricId?: string | undefined;
+  pricingUnitId?: string | null | undefined;
   invoiceDisplayName?: string | undefined;
   model?: string | undefined;
   properties?: models.PricePropertiesUnion$Outbound | undefined;
@@ -108,8 +94,9 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   UpdatePriceRequestBody
 > = z.object({
   billableMetricId: z.string().optional(),
+  pricingUnitId: z.nullable(z.string()).optional(),
   invoiceDisplayName: z.string().optional(),
-  model: UpdatePriceModel$outboundSchema.optional(),
+  model: models.PriceModelInput$outboundSchema.optional(),
   properties: models.PricePropertiesUnion$outboundSchema.optional(),
   paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
   billingCadence: z.nullable(z.string()).optional(),

package/src/models/price.ts

@@ -14,13 +14,13 @@ export const PriceObject = {
 } as const;
 export type PriceObject = ClosedEnum<typeof PriceObject>;
 
-export const PriceModel = {
+export const PriceModel1 = {
   Standard: "standard",
   Dynamic: "dynamic",
   Volume: "volume",
   Percentage: "percentage",
 } as const;
-export type PriceModel = ClosedEnum<typeof PriceModel>;
+export type PriceModel1 = ClosedEnum<typeof PriceModel1>;
 
 export const PricePaymentTerm = {
   Instant: "instant",
@@ -52,7 +52,7 @@ export type Price = {
   currency?: string | undefined;
   description?: string | undefined;
   invoiceDisplayName: string;
-  model: PriceModel;
+  model: PriceModel1;
   paymentTerm: PricePaymentTerm;
   properties: { [k: string]: any };
   unitAmount?: string | undefined;
@@ -76,8 +76,8 @@ export const PriceObject$inboundSchema: z.ZodNativeEnum<typeof PriceObject> = z
   .nativeEnum(PriceObject);
 
 /** @internal */
-export const PriceModel$inboundSchema: z.ZodNativeEnum<typeof PriceModel> = z
-  .nativeEnum(PriceModel);
+export const PriceModel1$inboundSchema: z.ZodNativeEnum<typeof PriceModel1> = z
+  .nativeEnum(PriceModel1);
 
 /** @internal */
 export const PricePaymentTerm$inboundSchema: z.ZodNativeEnum<
@@ -99,7 +99,7 @@ export const Price$inboundSchema: z.ZodType<Price, z.ZodTypeDef, unknown> = z
     currency: z.string().optional(),
     description: z.string().optional(),
     invoiceDisplayName: z.string(),
-    model: PriceModel$inboundSchema,
+    model: PriceModel1$inboundSchema,
     paymentTerm: PricePaymentTerm$inboundSchema,
     properties: z.record(z.any()),
     unitAmount: z.string().optional(),

package/src/models/pricemodel.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * Pricing model of a price as returned by the API. Includes legacy models ('dynamic', 'volume', 'percentage') retained for existing prices; only 'standard' can be created (see PriceModelInput).
+ */
+export const PriceModel = {
+  Standard: "standard",
+  Dynamic: "dynamic",
+  Volume: "volume",
+  Percentage: "percentage",
+} as const;
+/**
+ * Pricing model of a price as returned by the API. Includes legacy models ('dynamic', 'volume', 'percentage') retained for existing prices; only 'standard' can be created (see PriceModelInput).
+ */
+export type PriceModel = OpenEnum<typeof PriceModel>;
+
+/** @internal */
+export const PriceModel$inboundSchema: z.ZodType<
+  PriceModel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PriceModel);

package/src/models/pricemodelinput.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Pricing model accepted when creating or updating a price. Only 'standard' is creatable. Percentage-style and revenue-share pricing are expressed with 'standard' plus a unit-price multiplier (e.g. 10% ⇒ unitPrice '0.1'). The legacy 'dynamic', 'volume', and 'percentage' models remain billable and readable on existing prices but can no longer be created.
+ */
+export const PriceModelInput = {
+  Standard: "standard",
+} as const;
+/**
+ * Pricing model accepted when creating or updating a price. Only 'standard' is creatable. Percentage-style and revenue-share pricing are expressed with 'standard' plus a unit-price multiplier (e.g. 10% ⇒ unitPrice '0.1'). The legacy 'dynamic', 'volume', and 'percentage' models remain billable and readable on existing prices but can no longer be created.
+ */
+export type PriceModelInput = ClosedEnum<typeof PriceModelInput>;
+
+/** @internal */
+export const PriceModelInput$outboundSchema: z.ZodNativeEnum<
+  typeof PriceModelInput
+> = z.nativeEnum(PriceModelInput);

package/src/models/schemasprice.ts

@@ -8,6 +8,7 @@ import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import { PriceFeature, PriceFeature$inboundSchema } from "./pricefeature.js";
+import { PriceModel, PriceModel$inboundSchema } from "./pricemodel.js";
 import {
   PricePropertiesUnion,
   PricePropertiesUnion$inboundSchema,
@@ -18,14 +19,6 @@ export const SchemasPriceObject = {
 } as const;
 export type SchemasPriceObject = ClosedEnum<typeof SchemasPriceObject>;
 
-export const SchemasPriceModel = {
-  Standard: "standard",
-  Dynamic: "dynamic",
-  Volume: "volume",
-  Percentage: "percentage",
-} as const;
-export type SchemasPriceModel = ClosedEnum<typeof SchemasPriceModel>;
-
 export const SchemasPricePaymentTerm = {
   Instant: "instant",
   InArrears: "in_arrears",
@@ -49,6 +42,10 @@ export type SchemasPrice = {
    * The unique identifier for the fee referred to by this price. Present when price is linked to a fee.
    */
   feeId?: string | undefined;
+  /**
+   * Unique identifier for a pricing unit
+   */
+  pricingUnitId?: string | undefined;
   /**
    * Unique identifier for an organization
    */
@@ -59,7 +56,10 @@ export type SchemasPrice = {
   billingCadence?: string | null | undefined;
   createdAt: Date;
   invoiceDisplayName: string;
-  model?: SchemasPriceModel | undefined;
+  /**
+   * Pricing model of a price as returned by the API. Includes legacy models ('dynamic', 'volume', 'percentage') retained for existing prices; only 'standard' can be created (see PriceModelInput).
+   */
+  model?: PriceModel | undefined;
   paymentTerm: SchemasPricePaymentTerm;
   properties: PricePropertiesUnion;
   updatedAt: Date;
@@ -82,11 +82,6 @@ export const SchemasPriceObject$inboundSchema: z.ZodNativeEnum<
   typeof SchemasPriceObject
 > = z.nativeEnum(SchemasPriceObject);
 
-/** @internal */
-export const SchemasPriceModel$inboundSchema: z.ZodNativeEnum<
-  typeof SchemasPriceModel
-> = z.nativeEnum(SchemasPriceModel);
-
 /** @internal */
 export const SchemasPricePaymentTerm$inboundSchema: z.ZodNativeEnum<
   typeof SchemasPricePaymentTerm
@@ -102,11 +97,12 @@ export const SchemasPrice$inboundSchema: z.ZodType<
   object: SchemasPriceObject$inboundSchema.default("price"),
   billableMetricId: z.string().optional(),
   feeId: z.string().optional(),
+  pricingUnitId: z.string().optional(),
   merchantId: z.string(),
   billingCadence: z.nullable(z.string()).optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   invoiceDisplayName: z.string(),
-  model: SchemasPriceModel$inboundSchema.optional(),
+  model: PriceModel$inboundSchema.optional(),
   paymentTerm: SchemasPricePaymentTerm$inboundSchema,
   properties: PricePropertiesUnion$inboundSchema,
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),