@paygentic/sdk 0.9.7 → 0.9.8

package/src/models/subscriptionadjustment.ts

@@ -17,6 +17,7 @@ export type SubscriptionAdjustmentObject = ClosedEnum<
 
 export const SubscriptionAdjustmentType = {
   PercentageDiscount: "percentageDiscount",
+  UsageDiscount: "usageDiscount",
 } as const;
 export type SubscriptionAdjustmentType = ClosedEnum<
   typeof SubscriptionAdjustmentType
@@ -34,19 +35,27 @@ export type SubscriptionAdjustment = {
   subscriptionId: string;
   type: SubscriptionAdjustmentType;
   /**
-   * The discount rate as a decimal fraction between 0 and 1. "0.35" means 35 percent.
+   * The discount rate as a decimal fraction between 0 and 1. "0.35" means 35 percent. Null on a usageDiscount, which carries a unit count instead.
    */
-  percentageDiscount: string;
+  percentageDiscount: string | null;
   /**
-   * The first instant the discount applies. Inclusive.
+   * The number of usage units taken off the targeted line's billable quantity. Null on a percentageDiscount, which carries a rate instead.
+   */
+  usageDiscount: string | null;
+  /**
+   * The prices this adjustment reduces. Exactly one metered price on a usageDiscount; empty on a percentageDiscount, which reduces every discountable charge.
+   */
+  targetPriceIds: Array<string>;
+  /**
+   * Opens the window. Read per type: INCLUSIVE on a percentageDiscount, whose window is prorated by day overlap; EXCLUSIVE on a usageDiscount, which corrects a line whose period END falls strictly after this instant.
    */
   effectiveFrom: Date;
   /**
-   * The instant the discount stops applying. Exclusive. Null means the discount never stops.
+   * Closes the window, or null for never. Read per type: EXCLUSIVE on a percentageDiscount; INCLUSIVE on a usageDiscount, which corrects a line whose period END falls on or before this instant.
    */
   effectiveTo: Date | null;
   /**
-   * The deal's own name, shown on each discount line of the invoice.
+   * The deal's own name. Shown on each discount line a percentageDiscount emits; a usageDiscount emits no line, so its description is carried here only.
    */
   description: string | null;
   createdAt: Date;
@@ -72,7 +81,9 @@ export const SubscriptionAdjustment$inboundSchema: z.ZodType<
   id: z.string(),
   subscriptionId: z.string(),
   type: SubscriptionAdjustmentType$inboundSchema,
-  percentageDiscount: z.string(),
+  percentageDiscount: z.nullable(z.string()),
+  usageDiscount: z.nullable(z.string()),
+  targetPriceIds: z.array(z.string()),
   effectiveFrom: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ),

package/src/sdk/subscriptions.ts

@@ -149,7 +149,7 @@ export class Subscriptions extends ClientSDK {
    * Create Adjustment
    *
    * @remarks
-   * Attaches a percentage discount to the subscription for a dated window. Every invoice calculated while the window is open carries one discount line for each discounted charge, and tax is assessed on the reduced amount. An invoice that already exists is not changed, including one still in draft — the discount reaches the periods that close after it is created. There is no update operation, and a window cannot be changed after it is created. To change a rate before any invoice has issued under the discount, delete the adjustment and create a replacement. Once an invoice has issued the adjustment is permanent, so set effectiveTo at creation time whenever the deal has a known end date.
+   * Attaches an adjustment to the subscription for a dated window. A percentageDiscount reduces every discountable charge by a rate and carries one discount line per charge on the invoice. A usageDiscount takes a number of usage units off one metered price's billable quantity before that line is priced, so the line re-slots on a volume ladder and shows the corrected quantity; it emits no line of its own. Tax is assessed on the reduced amount either way. An invoice that already exists is not changed, including one still in draft — the adjustment reaches the periods that close after it is created. There is no update operation, and a window cannot be changed after it is created. To change an adjustment before any invoice has issued under it, delete it and create a replacement. Once an invoice has issued the adjustment is permanent, so set effectiveTo at creation time whenever the deal has a known end date.
    */
   async createSubscriptionAdjustment(
     request: operations.CreateSubscriptionAdjustmentRequest,