@paygentic/sdk 0.9.5 → 0.9.7

package/src/models/invoicelineitem.ts

@@ -21,6 +21,20 @@ export const EventType = {
  */
 export type EventType = ClosedEnum<typeof EventType>;
 
+/**
+ * When this line falls due relative to the window it covers: `in_advance` at the window's start, `in_arrears` at its end. A metered line is stamped `in_arrears`, because usage is only known once the window closes — but metered rows written before that rule carry `null` and were never backfilled, so do not read a metered line's term as guaranteed. `null` also means the line is not billed on a term of its own: manual, grant-discount and adjustment lines carry no term, and an adjustment instead falls due with the charge it reduces. Treat `null` as an expected value on any line type, not an error.
+ */
+export const InvoiceLineItemPaymentTerm = {
+  InAdvance: "in_advance",
+  InArrears: "in_arrears",
+} as const;
+/**
+ * When this line falls due relative to the window it covers: `in_advance` at the window's start, `in_arrears` at its end. A metered line is stamped `in_arrears`, because usage is only known once the window closes — but metered rows written before that rule carry `null` and were never backfilled, so do not read a metered line's term as guaranteed. `null` also means the line is not billed on a term of its own: manual, grant-discount and adjustment lines carry no term, and an adjustment instead falls due with the charge it reduces. Treat `null` as an expected value on any line type, not an error.
+ */
+export type InvoiceLineItemPaymentTerm = ClosedEnum<
+  typeof InvoiceLineItemPaymentTerm
+>;
+
 /**
  * Type of line item: 'charge' for regular billing, 'refund' for refunded items (amounts are negated)
  */
@@ -60,6 +74,18 @@ export type InvoiceLineItem = {
    * The price this line was generated from, or `null` when the line has no originating charge. With `itemId` it says whether a missing tag is fixable: `priceId` set and `itemId` null means the charge was simply untagged, which tagging it and restamping resolves; both null means the line records a grant-credit purchase, which is deferred revenue and is never tagged. Any measure of outstanding mapping work must exclude the latter or it can never reach zero.
    */
   priceId?: string | null | undefined;
+  /**
+   * Start of the billed window this line covers, inclusive. Distinct from the invoice's own period, which is the union of its lines' windows (earliest start to latest end) and so covers time no single line bills on a mixed-timing invoice.
+   */
+  periodStart?: Date | undefined;
+  /**
+   * End of the billed window this line covers, exclusive — the instant at `periodEnd` belongs to the next window. Equal to `periodStart` on a one-off charge, which bills at an instant and has no period grid.
+   */
+  periodEnd?: Date | undefined;
+  /**
+   * When this line falls due relative to the window it covers: `in_advance` at the window's start, `in_arrears` at its end. A metered line is stamped `in_arrears`, because usage is only known once the window closes — but metered rows written before that rule carry `null` and were never backfilled, so do not read a metered line's term as guaranteed. `null` also means the line is not billed on a term of its own: manual, grant-discount and adjustment lines carry no term, and an adjustment instead falls due with the charge it reduces. Treat `null` as an expected value on any line type, not an error.
+   */
+  paymentTerm?: InvoiceLineItemPaymentTerm | null | undefined;
   /**
    * Display name for this line item on invoices
    */
@@ -114,6 +140,11 @@ export type InvoiceLineItem = {
 export const EventType$inboundSchema: z.ZodNativeEnum<typeof EventType> = z
   .nativeEnum(EventType);
 
+/** @internal */
+export const InvoiceLineItemPaymentTerm$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceLineItemPaymentTerm
+> = z.nativeEnum(InvoiceLineItemPaymentTerm);
+
 /** @internal */
 export const InvoiceLineItemLineItemType$inboundSchema: z.ZodNativeEnum<
   typeof InvoiceLineItemLineItemType
@@ -131,6 +162,11 @@ export const InvoiceLineItem$inboundSchema: z.ZodType<
   billableMetricId: z.string(),
   itemId: z.nullable(z.string()).optional(),
   priceId: z.nullable(z.string()).optional(),
+  periodStart: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  periodEnd: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  paymentTerm: z.nullable(InvoiceLineItemPaymentTerm$inboundSchema).optional(),
   invoiceDisplayName: z.string(),
   lineItemType: InvoiceLineItemLineItemType$inboundSchema,
   meterEventId: z.string(),

package/src/models/lineitem.ts

@@ -36,14 +36,14 @@ export const LineItemStatus = {
 export type LineItemStatus = ClosedEnum<typeof LineItemStatus>;
 
 /**
- * Payment term for fee items. Null for metered/manual lines. `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.
+ * 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.
  */
 export const LineItemPaymentTerm = {
   InAdvance: "in_advance",
   InArrears: "in_arrears",
 } as const;
 /**
- * Payment term for fee items. Null for metered/manual lines. `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.
+ * 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.
  */
 export type LineItemPaymentTerm = ClosedEnum<typeof LineItemPaymentTerm>;
 
@@ -121,7 +121,7 @@ export type LineItem = {
    */
   meteredQuantity?: string | null | undefined;
   /**
-   * Payment term for fee items. Null for metered/manual lines. `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.
+   * 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.
    */
   paymentTerm?: LineItemPaymentTerm | null | undefined;
   /**

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;
   /**
@@ -53,6 +53,10 @@ export type CreatePriceRequest = {
    * 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.
    */
@@ -76,6 +80,7 @@ export type CreatePriceRequest$Outbound = {
   properties: models.PriceProperties$Outbound;
   feature?: models.PriceFeatureInput$Outbound | undefined;
   grantDiscountEnabled: boolean;
+  isObligation: boolean;
   quantity?: number | undefined;
 };
 
@@ -95,6 +100,7 @@ export const CreatePriceRequest$outboundSchema: z.ZodType<
   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/updateprice.ts

@@ -36,7 +36,7 @@ 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.PriceProperties | undefined;
@@ -56,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.
    */
@@ -92,6 +96,7 @@ export type UpdatePriceRequestBody$Outbound = {
   billingCadence?: string | null | undefined;
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
   grantDiscountEnabled?: boolean | undefined;
+  isObligation?: boolean | undefined;
   quantity?: number | undefined;
 };
 
@@ -110,6 +115,7 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   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(),
 });
 

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>;
 

package/src/models/schemasprice.ts

@@ -56,7 +56,7 @@ export type SchemasPrice = {
   createdAt: Date;
   invoiceDisplayName: string;
   /**
-   * 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).
    */
   model?: PriceModel | undefined;
   paymentTerm: SchemasPricePaymentTerm;
@@ -70,6 +70,10 @@ export type SchemasPrice = {
    * 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 for invoice line items. 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 SchemasPrice$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(),
 });