@paygentic/sdk 0.9.7 → 0.9.8

package/src/models/createsubscriptionadjustmentrequest.ts

@@ -3,76 +3,38 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../types/enums.js";
+import {
+  CreatePercentageDiscountAdjustment,
+  CreatePercentageDiscountAdjustment$Outbound,
+  CreatePercentageDiscountAdjustment$outboundSchema,
+} from "./createpercentagediscountadjustment.js";
+import {
+  CreateUsageDiscountAdjustment,
+  CreateUsageDiscountAdjustment$Outbound,
+  CreateUsageDiscountAdjustment$outboundSchema,
+} from "./createusagediscountadjustment.js";
 
 /**
- * The kind of adjustment. `percentageDiscount` reduces every discountable charge by a rate.
+ * One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount.
  */
-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);
+export type CreateSubscriptionAdjustmentRequest =
+  | CreatePercentageDiscountAdjustment
+  | CreateUsageDiscountAdjustment;
 
 /** @internal */
-export type CreateSubscriptionAdjustmentRequest$Outbound = {
-  type: string;
-  percentageDiscount: string;
-  effectiveFrom: string;
-  effectiveTo?: string | null | undefined;
-  description?: string | null | undefined;
-  idempotencyKey?: string | undefined;
-};
+export type CreateSubscriptionAdjustmentRequest$Outbound =
+  | CreatePercentageDiscountAdjustment$Outbound
+  | CreateUsageDiscountAdjustment$Outbound;
 
 /** @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(),
-});
+> = z.union([
+  CreatePercentageDiscountAdjustment$outboundSchema,
+  CreateUsageDiscountAdjustment$outboundSchema,
+]);
 
 export function createSubscriptionAdjustmentRequestToJSON(
   createSubscriptionAdjustmentRequest: CreateSubscriptionAdjustmentRequest,

package/src/models/createusagediscountadjustment.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CreateUsageDiscountAdjustment = {
+  /**
+   * Reduces one metered price's billable quantity by a number of usage units, before the line is priced.
+   */
+  type: "usageDiscount";
+  /**
+   * The number of usage units to take off the billable quantity, sent as a plain decimal string. "300" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so "1_000" and "1e3" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting.
+   */
+  usageDiscount: string;
+  /**
+   * Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.
+   */
+  targetPriceIds: Array<string>;
+  /**
+   * Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.
+   */
+  effectiveFrom: Date;
+  /**
+   * Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.
+   */
+  effectiveTo?: Date | null | undefined;
+  /**
+   * Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.
+   */
+  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 usage discounts against one price SUM — two of "300" waive 600 units, not 300. Nothing else detects a duplicate.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export type CreateUsageDiscountAdjustment$Outbound = {
+  type: "usageDiscount";
+  usageDiscount: string;
+  targetPriceIds: Array<string>;
+  effectiveFrom: string;
+  effectiveTo?: string | null | undefined;
+  description?: string | null | undefined;
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export const CreateUsageDiscountAdjustment$outboundSchema: z.ZodType<
+  CreateUsageDiscountAdjustment$Outbound,
+  z.ZodTypeDef,
+  CreateUsageDiscountAdjustment
+> = z.object({
+  type: z.literal("usageDiscount"),
+  usageDiscount: z.string(),
+  targetPriceIds: z.array(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 createUsageDiscountAdjustmentToJSON(
+  createUsageDiscountAdjustment: CreateUsageDiscountAdjustment,
+): string {
+  return JSON.stringify(
+    CreateUsageDiscountAdjustment$outboundSchema.parse(
+      createUsageDiscountAdjustment,
+    ),
+  );
+}

package/src/models/index.ts

@@ -21,8 +21,10 @@ export * from "./createmanuallineitemrequest.js";
 export * from "./createorderapprovalrequest.js";
 export * from "./createorderlineitemrequest.js";
 export * from "./createorderrequest.js";
+export * from "./createpercentagediscountadjustment.js";
 export * from "./createrulerequest.js";
 export * from "./createsubscriptionadjustmentrequest.js";
+export * from "./createusagediscountadjustment.js";
 export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
 export * from "./entitlementdetail.js";
@@ -77,12 +79,14 @@ export * from "./pricefeatureinput.js";
 export * from "./pricemodel.js";
 export * from "./pricemodelinput.js";
 export * from "./priceproperties.js";
+export * from "./pricetax.js";
 export * from "./product.js";
 export * from "./profitabilityrow.js";
 export * from "./profitabilitysummaryresponse.js";
 export * from "./profitabilitytrend.js";
 export * from "./purchasegrantrequest.js";
 export * from "./purchasegrantresponse.js";
+export * from "./ratetype.js";
 export * from "./reconciledfeatureadded.js";
 export * from "./reconciledfeaturefailed.js";
 export * from "./reconciledfeatureremoved.js";

package/src/models/lineitem.ts

@@ -120,6 +120,10 @@ export type LineItem = {
    * Raw metered usage. Null for fee/manual lines
    */
   meteredQuantity?: string | null | undefined;
+  /**
+   * The subscription adjustments of type `usageDiscount` that reduced this line's billable `quantity`. Empty for every other line. Where this is non-empty, `quantity` is below `meteredQuantity` because an operator waived units, rather than because a grant covered them.
+   */
+  usageDiscountIds?: Array<string> | undefined;
   /**
    * When the line falls due relative to the window it covers. A fee line carries its price's term; a metered line is stamped `in_arrears`, though metered rows predating that rule carry `null`. Manual, grant-discount and adjustment lines are billed on no term of their own and are `null`. `null` is listed in the enum as well as via `nullable` because OpenAPI 3.0 validators check the enum independently — `nullable: true` alone does not admit it, and createLineItem (which always returns null here) was emitting a schema-violating body.
    */
@@ -196,6 +200,7 @@ export const LineItem$inboundSchema: z.ZodType<
   quantity: z.nullable(z.string()).optional(),
   unitPrice: z.string(),
   meteredQuantity: z.nullable(z.string()).optional(),
+  usageDiscountIds: z.array(z.string()).optional(),
   paymentTerm: z.nullable(LineItemPaymentTerm$inboundSchema).optional(),
   subtotal: z.string().optional(),
   taxesTotal: z.nullable(z.string()).optional(),

package/src/models/operations/createprice.ts

@@ -39,6 +39,10 @@ export type CreatePriceRequest = {
    * 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)'
    */
   invoiceDisplayName: string;
+  /**
+   * Presentation only. Prices sharing this value, within one billing period, print as a single row on the rendered invoice PDF and are described by this string. Every member still bills its own line item on the ledger, this API and the compliance document. The combined row's rate is derived from the members' own rates. Requires the 'standard' pricing model. Sample values: 'Cross Border Fees', 'FX Fees'
+   */
+  invoiceDisplayGroup?: string | null | undefined;
   /**
    * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
    */
@@ -57,6 +61,14 @@ export type CreatePriceRequest = {
    * 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;
+  /**
+   * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+   */
+  rateType?: models.RateType | undefined;
+  /**
+   * A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.
+   */
+  tax?: models.PriceTax | 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.
    */
@@ -75,12 +87,15 @@ export type CreatePriceRequest$Outbound = {
   pricingUnitId?: string | undefined;
   model?: string | undefined;
   invoiceDisplayName: string;
+  invoiceDisplayGroup?: string | null | undefined;
   paymentTerm: string;
   billingCadence?: string | null | undefined;
   properties: models.PriceProperties$Outbound;
   feature?: models.PriceFeatureInput$Outbound | undefined;
   grantDiscountEnabled: boolean;
   isObligation: boolean;
+  rateType?: string | undefined;
+  tax?: models.PriceTax$Outbound | undefined;
   quantity?: number | undefined;
 };
 
@@ -95,12 +110,15 @@ export const CreatePriceRequest$outboundSchema: z.ZodType<
   pricingUnitId: z.string().optional(),
   model: models.PriceModelInput$outboundSchema.optional(),
   invoiceDisplayName: z.string(),
+  invoiceDisplayGroup: z.nullable(z.string()).optional(),
   paymentTerm: CreatePricePaymentTerm$outboundSchema,
   billingCadence: z.nullable(z.string()).optional(),
   properties: models.PriceProperties$outboundSchema,
   feature: models.PriceFeatureInput$outboundSchema.optional(),
   grantDiscountEnabled: z.boolean().default(false),
   isObligation: z.boolean().default(false),
+  rateType: models.RateType$outboundSchema.optional(),
+  tax: models.PriceTax$outboundSchema.optional(),
   quantity: z.number().int().optional(),
 });
 

package/src/models/operations/updateprice.ts

@@ -35,6 +35,10 @@ export type UpdatePriceRequestBody = {
    * Updated invoice line item label. Sample values: 'LLM Token Usage', 'Storage Charges', 'API Call Fees'
    */
   invoiceDisplayName?: string | undefined;
+  /**
+   * Presentation only. Prices sharing this value, within one billing period, print as a single row on the rendered invoice PDF and are described by this string. Every member still bills its own line item on the ledger, this API and the compliance document. The combined row's rate is derived from the members' own rates. Requires the 'standard' pricing model. Sample values: 'Cross Border Fees', 'FX Fees'
+   */
+  invoiceDisplayGroup?: string | null | undefined;
   /**
    * 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.
    */
@@ -60,6 +64,14 @@ export type UpdatePriceRequestBody = {
    * 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;
+  /**
+   * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+   */
+  rateType?: models.RateType | undefined;
+  /**
+   * A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.
+   */
+  tax?: models.PriceTax | 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.
    */
@@ -90,6 +102,7 @@ export type UpdatePriceRequestBody$Outbound = {
   billableMetricId?: string | undefined;
   pricingUnitId?: string | null | undefined;
   invoiceDisplayName?: string | undefined;
+  invoiceDisplayGroup?: string | null | undefined;
   model?: string | undefined;
   properties?: models.PriceProperties$Outbound | undefined;
   paymentTerm?: string | undefined;
@@ -97,6 +110,8 @@ export type UpdatePriceRequestBody$Outbound = {
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
   grantDiscountEnabled?: boolean | undefined;
   isObligation?: boolean | undefined;
+  rateType?: string | undefined;
+  tax?: models.PriceTax$Outbound | undefined;
   quantity?: number | undefined;
 };
 
@@ -109,6 +124,7 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   billableMetricId: z.string().optional(),
   pricingUnitId: z.nullable(z.string()).optional(),
   invoiceDisplayName: z.string().optional(),
+  invoiceDisplayGroup: z.nullable(z.string()).optional(),
   model: models.PriceModelInput$outboundSchema.optional(),
   properties: models.PriceProperties$outboundSchema.optional(),
   paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
@@ -116,6 +132,8 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   feature: z.nullable(models.PriceFeatureInput$outboundSchema).optional(),
   grantDiscountEnabled: z.boolean().optional(),
   isObligation: z.boolean().optional(),
+  rateType: models.RateType$outboundSchema.optional(),
+  tax: models.PriceTax$outboundSchema.optional(),
   quantity: z.number().int().optional(),
 });
 

package/src/models/planversionpriceslot.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 { PriceTax, PriceTax$inboundSchema } from "./pricetax.js";
 
 export const PlanVersionPriceSlotObject = {
   Price: "price",
@@ -34,6 +35,20 @@ export type PlanVersionPriceSlotPaymentTerm = ClosedEnum<
   typeof PlanVersionPriceSlotPaymentTerm
 >;
 
+/**
+ * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+ */
+export const PlanVersionPriceSlotRateType = {
+  Amount: "amount",
+  Proportion: "proportion",
+} as const;
+/**
+ * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+ */
+export type PlanVersionPriceSlotRateType = ClosedEnum<
+  typeof PlanVersionPriceSlotRateType
+>;
+
 /**
  * One price slot on a plan version. Every `Price` field is present, plus `priceDeleted` layered on top.
  */
@@ -77,6 +92,14 @@ export type PlanVersionPriceSlot = {
    * 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;
+  /**
+   * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+   */
+  rateType: PlanVersionPriceSlotRateType;
+  /**
+   * A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.
+   */
+  tax: PriceTax;
   /**
    * 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.
    */
@@ -102,6 +125,11 @@ export const PlanVersionPriceSlotPaymentTerm$inboundSchema: z.ZodNativeEnum<
   typeof PlanVersionPriceSlotPaymentTerm
 > = z.nativeEnum(PlanVersionPriceSlotPaymentTerm);
 
+/** @internal */
+export const PlanVersionPriceSlotRateType$inboundSchema: z.ZodNativeEnum<
+  typeof PlanVersionPriceSlotRateType
+> = z.nativeEnum(PlanVersionPriceSlotRateType);
+
 /** @internal */
 export const PlanVersionPriceSlot$inboundSchema: z.ZodType<
   PlanVersionPriceSlot,
@@ -126,6 +154,8 @@ export const PlanVersionPriceSlot$inboundSchema: z.ZodType<
   features: z.array(PriceFeature$inboundSchema).optional(),
   grantDiscountEnabled: z.boolean().default(false),
   isObligation: z.boolean().default(false),
+  rateType: PlanVersionPriceSlotRateType$inboundSchema.default("amount"),
+  tax: PriceTax$inboundSchema,
   quantity: z.number().int().default(1),
   priceDeleted: z.boolean(),
 });

package/src/models/price.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 { PriceTax, PriceTax$inboundSchema } from "./pricetax.js";
 
 export const PriceObject = {
   Price: "price",
@@ -28,6 +29,18 @@ export const PricePaymentTerm = {
 } as const;
 export type PricePaymentTerm = ClosedEnum<typeof PricePaymentTerm>;
 
+/**
+ * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+ */
+export const PriceRateType = {
+  Amount: "amount",
+  Proportion: "proportion",
+} as const;
+/**
+ * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+ */
+export type PriceRateType = ClosedEnum<typeof PriceRateType>;
+
 export type Price = {
   /**
    * Unique identifier for a price
@@ -68,6 +81,14 @@ export type Price = {
    * 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;
+  /**
+   * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+   */
+  rateType: PriceRateType;
+  /**
+   * A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.
+   */
+  tax: PriceTax;
   /**
    * 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.
    */
@@ -87,6 +108,11 @@ export const PricePaymentTerm$inboundSchema: z.ZodNativeEnum<
   typeof PricePaymentTerm
 > = z.nativeEnum(PricePaymentTerm);
 
+/** @internal */
+export const PriceRateType$inboundSchema: z.ZodNativeEnum<
+  typeof PriceRateType
+> = z.nativeEnum(PriceRateType);
+
 /** @internal */
 export const Price$inboundSchema: z.ZodType<Price, z.ZodTypeDef, unknown> = z
   .object({
@@ -112,6 +138,8 @@ 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),
+    rateType: PriceRateType$inboundSchema.default("amount"),
+    tax: PriceTax$inboundSchema,
     quantity: z.number().int().default(1),
   });
 

package/src/models/pricetax.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Whether this price's money is consideration for a supply — the one tax fact only you can state, because it is settled when you agree the deal rather than derived from what was sold. `IN_SCOPE` (the default) is consideration: it enters the taxable amount, positive as a charge or negative as a reduction in the price of the supply it applies to. `OUTSIDE_SCOPE` money is not consideration for anything, so it does not change the taxable amount, carries no tax, does not appear on the tax document, and nets into the amount payable after tax. This means "not consideration for a supply" — it does NOT mean "a supply outside this jurisdiction": exports and place-of-supply answers are worked out from the addresses on the sale by the tax provider, and are never declared on a price. How a supply is then classified — standard, zero-rated, exempt — is the tax provider's determination and is not set here either. Omit the whole `tax` object to leave a price in scope; there is deliberately no schema default on this property, so that a misspelt key is refused rather than silently defaulted.
+ */
+export const SupplyScope = {
+  InScope: "IN_SCOPE",
+  OutsideScope: "OUTSIDE_SCOPE",
+} as const;
+/**
+ * Whether this price's money is consideration for a supply — the one tax fact only you can state, because it is settled when you agree the deal rather than derived from what was sold. `IN_SCOPE` (the default) is consideration: it enters the taxable amount, positive as a charge or negative as a reduction in the price of the supply it applies to. `OUTSIDE_SCOPE` money is not consideration for anything, so it does not change the taxable amount, carries no tax, does not appear on the tax document, and nets into the amount payable after tax. This means "not consideration for a supply" — it does NOT mean "a supply outside this jurisdiction": exports and place-of-supply answers are worked out from the addresses on the sale by the tax provider, and are never declared on a price. How a supply is then classified — standard, zero-rated, exempt — is the tax provider's determination and is not set here either. Omit the whole `tax` object to leave a price in scope; there is deliberately no schema default on this property, so that a misspelt key is refused rather than silently defaulted.
+ */
+export type SupplyScope = ClosedEnum<typeof SupplyScope>;
+
+/**
+ * What an `OUTSIDE_SCOPE` amount is called in the invoice totals, so the wording follows the declaration rather than being retyped per price. Required when `supplyScope` is `OUTSIDE_SCOPE`, and rejected otherwise. `CASHBACK` is the only value today, and a price declaring it must use the `standard` model and must not carry a positive `unitPrice` — a cashback is money paid back, not charged.
+ */
+export const OutsideScopeLabel = {
+  Cashback: "CASHBACK",
+} as const;
+/**
+ * What an `OUTSIDE_SCOPE` amount is called in the invoice totals, so the wording follows the declaration rather than being retyped per price. Required when `supplyScope` is `OUTSIDE_SCOPE`, and rejected otherwise. `CASHBACK` is the only value today, and a price declaring it must use the `standard` model and must not carry a positive `unitPrice` — a cashback is money paid back, not charged.
+ */
+export type OutsideScopeLabel = ClosedEnum<typeof OutsideScopeLabel>;
+
+/**
+ * A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.
+ */
+export type PriceTax = {
+  /**
+   * Whether this price's money is consideration for a supply — the one tax fact only you can state, because it is settled when you agree the deal rather than derived from what was sold. `IN_SCOPE` (the default) is consideration: it enters the taxable amount, positive as a charge or negative as a reduction in the price of the supply it applies to. `OUTSIDE_SCOPE` money is not consideration for anything, so it does not change the taxable amount, carries no tax, does not appear on the tax document, and nets into the amount payable after tax. This means "not consideration for a supply" — it does NOT mean "a supply outside this jurisdiction": exports and place-of-supply answers are worked out from the addresses on the sale by the tax provider, and are never declared on a price. How a supply is then classified — standard, zero-rated, exempt — is the tax provider's determination and is not set here either. Omit the whole `tax` object to leave a price in scope; there is deliberately no schema default on this property, so that a misspelt key is refused rather than silently defaulted.
+   */
+  supplyScope: SupplyScope;
+  /**
+   * What an `OUTSIDE_SCOPE` amount is called in the invoice totals, so the wording follows the declaration rather than being retyped per price. Required when `supplyScope` is `OUTSIDE_SCOPE`, and rejected otherwise. `CASHBACK` is the only value today, and a price declaring it must use the `standard` model and must not carry a positive `unitPrice` — a cashback is money paid back, not charged.
+   */
+  outsideScopeLabel?: OutsideScopeLabel | null | undefined;
+};
+
+/** @internal */
+export const SupplyScope$inboundSchema: z.ZodNativeEnum<typeof SupplyScope> = z
+  .nativeEnum(SupplyScope);
+/** @internal */
+export const SupplyScope$outboundSchema: z.ZodNativeEnum<typeof SupplyScope> =
+  SupplyScope$inboundSchema;
+
+/** @internal */
+export const OutsideScopeLabel$inboundSchema: z.ZodNativeEnum<
+  typeof OutsideScopeLabel
+> = z.nativeEnum(OutsideScopeLabel);
+/** @internal */
+export const OutsideScopeLabel$outboundSchema: z.ZodNativeEnum<
+  typeof OutsideScopeLabel
+> = OutsideScopeLabel$inboundSchema;
+
+/** @internal */
+export const PriceTax$inboundSchema: z.ZodType<
+  PriceTax,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  supplyScope: SupplyScope$inboundSchema,
+  outsideScopeLabel: z.nullable(OutsideScopeLabel$inboundSchema).optional(),
+});
+/** @internal */
+export type PriceTax$Outbound = {
+  supplyScope: string;
+  outsideScopeLabel?: string | null | undefined;
+};
+
+/** @internal */
+export const PriceTax$outboundSchema: z.ZodType<
+  PriceTax$Outbound,
+  z.ZodTypeDef,
+  PriceTax
+> = z.object({
+  supplyScope: SupplyScope$outboundSchema,
+  outsideScopeLabel: z.nullable(OutsideScopeLabel$outboundSchema).optional(),
+});
+
+export function priceTaxToJSON(priceTax: PriceTax): string {
+  return JSON.stringify(PriceTax$outboundSchema.parse(priceTax));
+}
+export function priceTaxFromJSON(
+  jsonString: string,
+): SafeParseResult<PriceTax, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PriceTax$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PriceTax' from JSON`,
+  );
+}

package/src/models/ratetype.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+ */
+export const RateType = {
+  Amount: "amount",
+  Proportion: "proportion",
+} as const;
+/**
+ * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+ */
+export type RateType = ClosedEnum<typeof RateType>;
+
+/** @internal */
+export const RateType$inboundSchema: z.ZodNativeEnum<typeof RateType> = z
+  .nativeEnum(RateType);
+/** @internal */
+export const RateType$outboundSchema: z.ZodNativeEnum<typeof RateType> =
+  RateType$inboundSchema;

package/src/models/schemasprice.ts

@@ -13,6 +13,8 @@ import {
   PriceProperties,
   PriceProperties$inboundSchema,
 } from "./priceproperties.js";
+import { PriceTax, PriceTax$inboundSchema } from "./pricetax.js";
+import { RateType, RateType$inboundSchema } from "./ratetype.js";
 
 export const SchemasPriceObject = {
   Price: "price",
@@ -55,6 +57,10 @@ export type SchemasPrice = {
   billingCadence?: string | null | undefined;
   createdAt: Date;
   invoiceDisplayName: string;
+  /**
+   * Presentation only. Prices sharing this value, within one billing period, print as a single row on the rendered invoice PDF and are described by this string. Every member still bills its own line item on the ledger, this API and the compliance document. The combined row's rate is derived from the members' own rates. Requires the 'standard' pricing model. Sample values: 'Cross Border Fees', 'FX Fees'
+   */
+  invoiceDisplayGroup?: string | null | undefined;
   /**
    * 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).
    */
@@ -74,6 +80,14 @@ export type SchemasPrice = {
    * 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;
+  /**
+   * What properties.unitPrice is denominated in. 'amount' (the default) is an amount of the invoice currency for each unit metered, so the quantity is the multiplier. 'proportion' is the reverse: a dimensionless share of a currency-denominated quantity, so '0.02' is 2% and the invoice prints '2.00%'. Presentation only. Requires a standard metered price in real currency.
+   */
+  rateType?: RateType | undefined;
+  /**
+   * A price's tax declaration. Optional on write — a price that declares nothing is `IN_SCOPE`, and is billed and taxed exactly as it was before this object existed. Always present on read. Replaced as a whole on update: send the object to change it, omit it to leave it alone.
+   */
+  tax: PriceTax;
   /**
    * Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
    */
@@ -105,6 +119,7 @@ export const SchemasPrice$inboundSchema: z.ZodType<
   billingCadence: z.nullable(z.string()).optional(),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   invoiceDisplayName: z.string(),
+  invoiceDisplayGroup: z.nullable(z.string()).optional(),
   model: PriceModel$inboundSchema.optional(),
   paymentTerm: SchemasPricePaymentTerm$inboundSchema,
   properties: PriceProperties$inboundSchema,
@@ -112,6 +127,8 @@ export const SchemasPrice$inboundSchema: z.ZodType<
   features: z.array(PriceFeature$inboundSchema).optional(),
   grantDiscountEnabled: z.boolean().default(false),
   isObligation: z.boolean().default(false),
+  rateType: RateType$inboundSchema.optional(),
+  tax: PriceTax$inboundSchema,
   quantity: z.number().int(),
 });