@paygentic/sdk 0.9.4 → 0.9.6

package/src/models/createsubscriptionadjustmentrequest.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * The kind of adjustment. `percentageDiscount` reduces every discountable charge by a rate.
+ */
+export const CreateSubscriptionAdjustmentRequestType = {
+  PercentageDiscount: "percentageDiscount",
+} as const;
+/**
+ * The kind of adjustment. `percentageDiscount` reduces every discountable charge by a rate.
+ */
+export type CreateSubscriptionAdjustmentRequestType = ClosedEnum<
+  typeof CreateSubscriptionAdjustmentRequestType
+>;
+
+export type CreateSubscriptionAdjustmentRequest = {
+  /**
+   * The kind of adjustment. `percentageDiscount` reduces every discountable charge by a rate.
+   */
+  type: CreateSubscriptionAdjustmentRequestType;
+  /**
+   * The discount rate as a decimal fraction between 0 and 1, sent as a string. "0.35" means 35 percent. "1" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.
+   */
+  percentageDiscount: string;
+  /**
+   * The first instant the discount applies. Inclusive.
+   */
+  effectiveFrom: Date;
+  /**
+   * The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.
+   */
+  effectiveTo?: Date | null | undefined;
+  /**
+   * The deal's own name, shown on each discount line of the invoice.
+   */
+  description?: string | null | undefined;
+  /**
+   * A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export const CreateSubscriptionAdjustmentRequestType$outboundSchema:
+  z.ZodNativeEnum<typeof CreateSubscriptionAdjustmentRequestType> = z
+    .nativeEnum(CreateSubscriptionAdjustmentRequestType);
+
+/** @internal */
+export type CreateSubscriptionAdjustmentRequest$Outbound = {
+  type: string;
+  percentageDiscount: string;
+  effectiveFrom: string;
+  effectiveTo?: string | null | undefined;
+  description?: string | null | undefined;
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export const CreateSubscriptionAdjustmentRequest$outboundSchema: z.ZodType<
+  CreateSubscriptionAdjustmentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateSubscriptionAdjustmentRequest
+> = z.object({
+  type: CreateSubscriptionAdjustmentRequestType$outboundSchema,
+  percentageDiscount: z.string(),
+  effectiveFrom: z.date().transform(v => v.toISOString()),
+  effectiveTo: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  description: z.nullable(z.string()).optional(),
+  idempotencyKey: z.string().optional(),
+});
+
+export function createSubscriptionAdjustmentRequestToJSON(
+  createSubscriptionAdjustmentRequest: CreateSubscriptionAdjustmentRequest,
+): string {
+  return JSON.stringify(
+    CreateSubscriptionAdjustmentRequest$outboundSchema.parse(
+      createSubscriptionAdjustmentRequest,
+    ),
+  );
+}

package/src/models/errors/index.ts

@@ -12,4 +12,5 @@ export * from "./paygenticdefaulterror.js";
 export * from "./paygenticerror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./updateprice.js";
 export * from "./validationerror.js";

package/src/models/errors/updateprice.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as operations from "../operations/index.js";
+import { PaygenticError } from "./paygenticerror.js";
+
+/**
+ * Price cannot be restructured because a subscription still bills it directly
+ */
+export type UpdatePriceConflictErrorData = {
+  error?: string | undefined;
+  message: string;
+  /**
+   * Machine-readable conflict code. Open set: a new code may appear, so branch on the ones you handle and treat anything else as an unhandled conflict.
+   */
+  code: string;
+  details?: operations.UpdatePriceDetails | undefined;
+};
+
+/**
+ * Price cannot be restructured because a subscription still bills it directly
+ */
+export class UpdatePriceConflictError extends PaygenticError {
+  error?: string | undefined;
+  /**
+   * Machine-readable conflict code. Open set: a new code may appear, so branch on the ones you handle and treat anything else as an unhandled conflict.
+   */
+  code: string;
+  details?: operations.UpdatePriceDetails | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: UpdatePriceConflictErrorData;
+
+  constructor(
+    err: UpdatePriceConflictErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.error != null) this.error = err.error;
+    this.code = err.code;
+    if (err.details != null) this.details = err.details;
+
+    this.name = "UpdatePriceConflictError";
+  }
+}
+
+/** @internal */
+export const UpdatePriceConflictError$inboundSchema: z.ZodType<
+  UpdatePriceConflictError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string().optional(),
+  message: z.string(),
+  code: z.string(),
+  details: z.lazy(() => operations.UpdatePriceDetails$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UpdatePriceConflictError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/index.ts

@@ -22,6 +22,7 @@ export * from "./createorderapprovalrequest.js";
 export * from "./createorderlineitemrequest.js";
 export * from "./createorderrequest.js";
 export * from "./createrulerequest.js";
+export * from "./createsubscriptionadjustmentrequest.js";
 export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
 export * from "./entitlementdetail.js";
@@ -75,7 +76,7 @@ export * from "./pricefeature.js";
 export * from "./pricefeatureinput.js";
 export * from "./pricemodel.js";
 export * from "./pricemodelinput.js";
-export * from "./pricepropertiesunion.js";
+export * from "./priceproperties.js";
 export * from "./product.js";
 export * from "./profitabilityrow.js";
 export * from "./profitabilitysummaryresponse.js";
@@ -104,6 +105,8 @@ export * from "./sourcerule.js";
 export * from "./staticentitlementdetail.js";
 export * from "./staticentitlementlistitem.js";
 export * from "./subscription.js";
+export * from "./subscriptionadjustment.js";
+export * from "./subscriptionadjustmentsresponse.js";
 export * from "./subscriptionmetadata.js";
 export * from "./subscriptionportal.js";
 export * from "./subscriptionreconciliation.js";

package/src/models/operations/createprice.ts

@@ -32,7 +32,7 @@ export type CreatePriceRequest = {
    */
   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.
+   * Pricing calculation model. Required for billable metrics, optional for fees (defaults to 'standard'). 'standard' and 'volume' are accepted; fees only support 'standard'. For percentage/revenue-share use 'standard' with a unit-price multiplier. Legacy prices using 'dynamic'/'percentage' stay readable and billable but cannot be created.
    */
   model?: models.PriceModelInput | undefined;
   /**
@@ -47,12 +47,16 @@ export type CreatePriceRequest = {
    * ISO 8601 duration for recurring charges (e.g., 'P1M' for monthly, 'P1Y' for yearly) or 'P0D' for one-time charges. Required for fees, optional for billable metrics. Sample values: 'P0D' for one-time, 'P1M' for monthly recurring, 'P1Y' for yearly recurring
    */
   billingCadence?: string | null | undefined;
-  properties: models.PricePropertiesUnion;
+  properties: models.PriceProperties;
   feature?: models.PriceFeatureInput | undefined;
   /**
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
    */
   grantDiscountEnabled?: boolean | undefined;
+  /**
+   * A fixed amount owed whole rather than a per-period rate. An obligation is not prorated over a partial first period: when a subscription starts before its billing anchor, no truncated stub is billed and the first charge is the full amount at the next anchor. An obligation also refuses an interval boundary that falls strictly inside one of its own billing periods, since part of an amount owed whole is not a thing to bill. Defaults to false, which is a rate and is today's behaviour for every price. Not supported on a metered price, whose amount resolves from usage at close.
+   */
+  isObligation?: boolean | undefined;
   /**
    * Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
    */
@@ -73,9 +77,10 @@ export type CreatePriceRequest$Outbound = {
   invoiceDisplayName: string;
   paymentTerm: string;
   billingCadence?: string | null | undefined;
-  properties: models.PricePropertiesUnion$Outbound;
+  properties: models.PriceProperties$Outbound;
   feature?: models.PriceFeatureInput$Outbound | undefined;
   grantDiscountEnabled: boolean;
+  isObligation: boolean;
   quantity?: number | undefined;
 };
 
@@ -92,9 +97,10 @@ export const CreatePriceRequest$outboundSchema: z.ZodType<
   invoiceDisplayName: z.string(),
   paymentTerm: CreatePricePaymentTerm$outboundSchema,
   billingCadence: z.nullable(z.string()).optional(),
-  properties: models.PricePropertiesUnion$outboundSchema,
+  properties: models.PriceProperties$outboundSchema,
   feature: models.PriceFeatureInput$outboundSchema.optional(),
   grantDiscountEnabled: z.boolean().default(false),
+  isObligation: z.boolean().default(false),
   quantity: z.number().int().optional(),
 });
 

package/src/models/operations/createsubscriptionadjustment.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type CreateSubscriptionAdjustmentRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  createSubscriptionAdjustmentRequest:
+    models.CreateSubscriptionAdjustmentRequest;
+};
+
+/** @internal */
+export type CreateSubscriptionAdjustmentRequest$Outbound = {
+  id: string;
+  CreateSubscriptionAdjustmentRequest:
+    models.CreateSubscriptionAdjustmentRequest$Outbound;
+};
+
+/** @internal */
+export const CreateSubscriptionAdjustmentRequest$outboundSchema: z.ZodType<
+  CreateSubscriptionAdjustmentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateSubscriptionAdjustmentRequest
+> = z.object({
+  id: z.string(),
+  createSubscriptionAdjustmentRequest:
+    models.CreateSubscriptionAdjustmentRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createSubscriptionAdjustmentRequest: "CreateSubscriptionAdjustmentRequest",
+  });
+});
+
+export function createSubscriptionAdjustmentRequestToJSON(
+  createSubscriptionAdjustmentRequest: CreateSubscriptionAdjustmentRequest,
+): string {
+  return JSON.stringify(
+    CreateSubscriptionAdjustmentRequest$outboundSchema.parse(
+      createSubscriptionAdjustmentRequest,
+    ),
+  );
+}

package/src/models/operations/deletesubscriptionadjustment.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteSubscriptionAdjustmentRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  /**
+   * The adjustment ID
+   */
+  adjustmentId: string;
+};
+
+/** @internal */
+export type DeleteSubscriptionAdjustmentRequest$Outbound = {
+  id: string;
+  adjustmentId: string;
+};
+
+/** @internal */
+export const DeleteSubscriptionAdjustmentRequest$outboundSchema: z.ZodType<
+  DeleteSubscriptionAdjustmentRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteSubscriptionAdjustmentRequest
+> = z.object({
+  id: z.string(),
+  adjustmentId: z.string(),
+});
+
+export function deleteSubscriptionAdjustmentRequestToJSON(
+  deleteSubscriptionAdjustmentRequest: DeleteSubscriptionAdjustmentRequest,
+): string {
+  return JSON.stringify(
+    DeleteSubscriptionAdjustmentRequest$outboundSchema.parse(
+      deleteSubscriptionAdjustmentRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -25,6 +25,7 @@ export * from "./createprice.js";
 export * from "./createproduct.js";
 export * from "./createsource.js";
 export * from "./createsubscription.js";
+export * from "./createsubscriptionadjustment.js";
 export * from "./createtestclock.js";
 export * from "./deletebillingschedule.js";
 export * from "./deletecost.js";
@@ -36,6 +37,7 @@ export * from "./deleteorder.js";
 export * from "./deleteorderlineitem.js";
 export * from "./deleteprice.js";
 export * from "./deletesourcerule.js";
+export * from "./deletesubscriptionadjustment.js";
 export * from "./deletetestclock.js";
 export * from "./disconnectmerchantintegration.js";
 export * from "./downloadinvoicepdf.js";
@@ -103,6 +105,7 @@ export * from "./listscheduleinvoices.js";
 export * from "./listsourceevents.js";
 export * from "./listsourcerules.js";
 export * from "./listsources.js";
+export * from "./listsubscriptionadjustments.js";
 export * from "./listsubscriptions.js";
 export * from "./listtestclocks.js";
 export * from "./mintplanversion.js";

package/src/models/operations/listsubscriptionadjustments.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListSubscriptionAdjustmentsRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  /**
+   * Number of adjustments to return
+   */
+  limit?: string | undefined;
+  /**
+   * Number of adjustments to skip
+   */
+  offset?: string | undefined;
+};
+
+/** @internal */
+export type ListSubscriptionAdjustmentsRequest$Outbound = {
+  id: string;
+  limit: string;
+  offset: string;
+};
+
+/** @internal */
+export const ListSubscriptionAdjustmentsRequest$outboundSchema: z.ZodType<
+  ListSubscriptionAdjustmentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListSubscriptionAdjustmentsRequest
+> = z.object({
+  id: z.string(),
+  limit: z.string().default("10"),
+  offset: z.string().default("0"),
+});
+
+export function listSubscriptionAdjustmentsRequestToJSON(
+  listSubscriptionAdjustmentsRequest: ListSubscriptionAdjustmentsRequest,
+): string {
+  return JSON.stringify(
+    ListSubscriptionAdjustmentsRequest$outboundSchema.parse(
+      listSubscriptionAdjustmentsRequest,
+    ),
+  );
+}

package/src/models/operations/updateprice.ts

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as models from "../index.js";
 
 /**
@@ -33,10 +36,10 @@ export type UpdatePriceRequestBody = {
    */
   invoiceDisplayName?: string | undefined;
   /**
-   * 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.
+   * The pricing model to set. 'standard' and 'volume' are accepted. Legacy 'dynamic'/'percentage' prices can still be edited (other fields) but cannot be switched back to those models. Percentage/revenue-share is expressed via 'standard' with a unit-price multiplier.
    */
   model?: models.PriceModelInput | undefined;
-  properties?: models.PricePropertiesUnion | undefined;
+  properties?: models.PriceProperties | undefined;
   /**
    * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
    */
@@ -53,6 +56,10 @@ export type UpdatePriceRequestBody = {
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
    */
   grantDiscountEnabled?: boolean | undefined;
+  /**
+   * A fixed amount owed whole rather than a per-period rate. An obligation is not prorated over a partial first period: when a subscription starts before its billing anchor, no truncated stub is billed and the first charge is the full amount at the next anchor. An obligation also refuses an interval boundary that falls strictly inside one of its own billing periods, since part of an amount owed whole is not a thing to bill. Defaults to false, which is a rate and is today's behaviour for every price. Not supported on a metered price, whose amount resolves from usage at close.
+   */
+  isObligation?: boolean | undefined;
   /**
    * Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
    */
@@ -67,6 +74,12 @@ export type UpdatePriceRequest = {
   requestBody: UpdatePriceRequestBody;
 };
 
+export type UpdatePriceDetails = {
+  priceId?: string | undefined;
+  fields?: Array<string> | undefined;
+  subscriptionCount?: number | undefined;
+};
+
 /** @internal */
 export const UpdatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
   typeof UpdatePricePaymentTerm
@@ -78,11 +91,12 @@ export type UpdatePriceRequestBody$Outbound = {
   pricingUnitId?: string | null | undefined;
   invoiceDisplayName?: string | undefined;
   model?: string | undefined;
-  properties?: models.PricePropertiesUnion$Outbound | undefined;
+  properties?: models.PriceProperties$Outbound | undefined;
   paymentTerm?: string | undefined;
   billingCadence?: string | null | undefined;
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
   grantDiscountEnabled?: boolean | undefined;
+  isObligation?: boolean | undefined;
   quantity?: number | undefined;
 };
 
@@ -96,11 +110,12 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   pricingUnitId: z.nullable(z.string()).optional(),
   invoiceDisplayName: z.string().optional(),
   model: models.PriceModelInput$outboundSchema.optional(),
-  properties: models.PricePropertiesUnion$outboundSchema.optional(),
+  properties: models.PriceProperties$outboundSchema.optional(),
   paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
   billingCadence: z.nullable(z.string()).optional(),
   feature: z.nullable(models.PriceFeatureInput$outboundSchema).optional(),
   grantDiscountEnabled: z.boolean().optional(),
+  isObligation: z.boolean().optional(),
   quantity: z.number().int().optional(),
 });
 
@@ -139,3 +154,24 @@ export function updatePriceRequestToJSON(
     UpdatePriceRequest$outboundSchema.parse(updatePriceRequest),
   );
 }
+
+/** @internal */
+export const UpdatePriceDetails$inboundSchema: z.ZodType<
+  UpdatePriceDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  priceId: z.string().optional(),
+  fields: z.array(z.string()).optional(),
+  subscriptionCount: z.number().int().optional(),
+});
+
+export function updatePriceDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdatePriceDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdatePriceDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdatePriceDetails' from JSON`,
+  );
+}

package/src/models/planversionpriceslot.ts

@@ -73,6 +73,10 @@ export type PlanVersionPriceSlot = {
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
    */
   grantDiscountEnabled: boolean;
+  /**
+   * A fixed amount owed whole rather than a per-period rate. An obligation is not prorated over a partial first period: when a subscription starts before its billing anchor, no truncated stub is billed and the first charge is the full amount at the next anchor. An obligation also refuses an interval boundary that falls strictly inside one of its own billing periods, since part of an amount owed whole is not a thing to bill. Defaults to false, which is a rate and is today's behaviour for every price. Not supported on a metered price, whose amount resolves from usage at close.
+   */
+  isObligation: boolean;
   /**
    * Quantity used when generating invoice line items for this price. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
    */
@@ -121,6 +125,7 @@ export const PlanVersionPriceSlot$inboundSchema: z.ZodType<
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   features: z.array(PriceFeature$inboundSchema).optional(),
   grantDiscountEnabled: z.boolean().default(false),
+  isObligation: z.boolean().default(false),
   quantity: z.number().int().default(1),
   priceDeleted: z.boolean(),
 });

package/src/models/price.ts

@@ -64,6 +64,10 @@ export type Price = {
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
    */
   grantDiscountEnabled: boolean;
+  /**
+   * A fixed amount owed whole rather than a per-period rate. An obligation is not prorated over a partial first period: when a subscription starts before its billing anchor, no truncated stub is billed and the first charge is the full amount at the next anchor. An obligation also refuses an interval boundary that falls strictly inside one of its own billing periods, since part of an amount owed whole is not a thing to bill. Defaults to false, which is a rate and is today's behaviour for every price. Not supported on a metered price, whose amount resolves from usage at close.
+   */
+  isObligation: boolean;
   /**
    * Quantity used when generating invoice line items for this price. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
    */
@@ -107,6 +111,7 @@ export const Price$inboundSchema: z.ZodType<Price, z.ZodTypeDef, unknown> = z
     ),
     features: z.array(PriceFeature$inboundSchema).optional(),
     grantDiscountEnabled: z.boolean().default(false),
+    isObligation: z.boolean().default(false),
     quantity: z.number().int().default(1),
   });
 

package/src/models/pricemodel.ts

@@ -7,7 +7,7 @@ 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).
+ * Pricing model of a price as returned by the API. Includes the legacy models ('dynamic', 'percentage') retained for existing prices; 'standard' and 'volume' can be created (see PriceModelInput).
  */
 export const PriceModel = {
   Standard: "standard",
@@ -16,7 +16,7 @@ export const PriceModel = {
   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).
+ * Pricing model of a price as returned by the API. Includes the legacy models ('dynamic', 'percentage') retained for existing prices; 'standard' and 'volume' can be created (see PriceModelInput).
  */
 export type PriceModel = OpenEnum<typeof PriceModel>;
 

package/src/models/pricemodelinput.ts

@@ -6,13 +6,14 @@ 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.
+ * Pricing model accepted when creating or updating a price. 'standard' takes a single rate in properties.unitPrice; 'volume' takes a ladder of bands in properties.tiers. Percentage-style and revenue-share pricing are expressed with 'standard' plus a unit-price multiplier (e.g. 10% ⇒ unitPrice '0.1'). The legacy 'dynamic' and 'percentage' models remain billable and readable on existing prices but can no longer be created.
  */
 export const PriceModelInput = {
   Standard: "standard",
+  Volume: "volume",
 } 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.
+ * Pricing model accepted when creating or updating a price. 'standard' takes a single rate in properties.unitPrice; 'volume' takes a ladder of bands in properties.tiers. Percentage-style and revenue-share pricing are expressed with 'standard' plus a unit-price multiplier (e.g. 10% ⇒ unitPrice '0.1'). The legacy 'dynamic' and 'percentage' models remain billable and readable on existing prices but can no longer be created.
  */
 export type PriceModelInput = ClosedEnum<typeof PriceModelInput>;