@leaflow/sdk 0.0.0-dev.352.g85966ed → 0.0.0-dev.353.g74313e0

package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.d.ts

@@ -53,10 +53,13 @@ export declare const CancellationRefundPreview: zod.ZodObject<{
             id: zod.ZodUUID;
             name: zod.ZodString;
         }, zod.z.core.$strict>, zod.ZodNull]>>;
-        charge_type: zod.ZodEnum<{
-            postpaid: "postpaid";
-            prepaid: "prepaid";
+        type: zod.ZodEnum<{
             one_time: "one_time";
+            recurring: "recurring";
+        }>;
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
         }>;
         auto_renew: zod.ZodBoolean;
         unused_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.js

@@ -54,4 +54,4 @@ export const CancellationRefundPreview = zod
     forfeited_amount: Money,
     items: zod.array(CancellationRefundPreviewItem),
 })
-    .describe("What the cancellation would return, subscription by subscription and in total, as of now. Give\n`proration_date` and `refundable_amount` when creating the cancellation.\n\n- `unused_amount`: before tax, the amount paid for the current periods minus the value of the\n  time used, valued as refund policy `prorated` describes, whatever the refund terms say.\n- `refundable_amount`: what is returned the way it was paid, including the tax paid on it;\n  `refund_amount` plus `credit_amount`.\n- `refund_amount`: the part returned to the balance or to the payment method.\n- `credit_amount`: the part restored to the credit grants that paid.\n- `tax_amount`: the tax included in `refundable_amount`.\n- `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.\n\nPostpaid and one-time subscriptions show zero; usage until release is charged as usual.");
+    .describe("What the cancellation would return, per subscription and in total, as of now. Give `proration_date` and\n`refundable_amount` when creating the cancellation.\n\n- `unused_amount`: before tax, the amount paid for the current periods minus the value of the time used,\n  valued as refund policy `prorated` describes, whatever the refund terms say.\n- `refundable_amount`: what is returned the way it was paid, tax included; `refund_amount` plus\n  `credit_amount`.\n- `refund_amount`: the part returned to the balance or the payment method.\n- `credit_amount`: the part restored to the credit grants that paid.\n- `tax_amount`: the tax included in `refundable_amount`.\n- `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.\n\nMetered and one-time subscriptions show zero; their usage until release is charged as usual.");

package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts

@@ -39,10 +39,13 @@ export declare const CancellationRefundPreviewItem: zod.ZodObject<{
         id: zod.ZodUUID;
         name: zod.ZodString;
     }, zod.z.core.$strict>, zod.ZodNull]>>;
-    charge_type: zod.ZodEnum<{
-        postpaid: "postpaid";
-        prepaid: "prepaid";
+    type: zod.ZodEnum<{
         one_time: "one_time";
+        recurring: "recurring";
+    }>;
+    usage_type: zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
     }>;
     auto_renew: zod.ZodBoolean;
     unused_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.js

@@ -33,6 +33,8 @@
 import * as zod from "zod";
 import { Money } from "./money.zod.js";
 import { NamedIdentity } from "./namedIdentity.zod.js";
+import { PriceType } from "./priceType.zod.js";
+import { UsageType } from "./usageType.zod.js";
 export const CancellationRefundPreviewItem = zod
     .strictObject({
     subscription_id: zod.uuid(),
@@ -41,11 +43,12 @@ export const CancellationRefundPreviewItem = zod
     project: zod
         .union([NamedIdentity, zod.null()])
         .optional()
-        .describe("The project and its current name, for display. Absent for a purchase at account level, and when the\nproject details cannot be read at the moment."),
-    charge_type: zod.enum(["postpaid", "prepaid", "one_time"]),
+        .describe("The project and its current name. Absent for an account-level purchase or when the project cannot be read."),
+    type: PriceType,
+    usage_type: UsageType,
     auto_renew: zod
         .boolean()
-        .describe("Whether automatic renewal is on now. Creating the cancellation turns it off. Withdrawing the\ncancellation does not turn it back on for a prepaid subscription; a postpaid subscription continues\nuntil it is canceled and turns it back on."),
+        .describe("Whether automatic renewal is on now. Creating the cancellation turns it off; withdrawing it turns it back on for a metered subscription but not for a licensed one."),
     unused_amount: Money,
     refundable_amount: Money,
     refund_amount: Money,
@@ -53,4 +56,4 @@ export const CancellationRefundPreviewItem = zod
     tax_amount: Money,
     forfeited_amount: Money,
 })
-    .describe("One subscription of the quoted cancellation. The amounts mean what they mean in the total.");
+    .describe("One subscription of the quoted cancellation.");

package/dist/canopy/v1/generated/validators/contact.zod.js

@@ -57,8 +57,8 @@ export const Contact = zod
     address_country: zod.string().regex(contactAddressCountryRegExp).optional(),
     tax_exempt: zod
         .enum(["none", "exempt", "reverse"])
-        .describe("How tax applies to the customer, as in Stripe. `none` taxes normally. `exempt` charges no tax.\n`reverse` charges no tax and leaves it to the customer under the reverse-charge mechanism;\ninvoices state this. Only operators change it."),
+        .describe("How tax applies to the customer, as in Stripe: `none` taxes normally, `exempt` charges no tax, `reverse` charges no tax under the reverse-charge mechanism, stated on invoices. Only operators change it."),
     active: zod.boolean(),
     created_at: zod.iso.datetime({ offset: true }),
 })
-    .describe("A billing-account contact profile with one address. An account can hold multiple contacts; this is not a login identity.");
+    .describe("A contact of a billing account with one address. An account can hold several; a contact is not a login.");

package/dist/canopy/v1/generated/validators/createServiceResponseBody.zod.d.ts

@@ -57,7 +57,6 @@ export declare const CreateServiceResponseBody: zod.ZodObject<{
                 open: "open";
                 draft: "draft";
                 paid: "paid";
-                uncollectible: "uncollectible";
             }>;
             subtotal: zod.ZodString;
             discount_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/creditGrant.zod.d.ts

@@ -61,18 +61,20 @@ export declare const CreditGrant: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>;
-            billing_scheme: zod.ZodEnum<{
+            billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                 per_unit: "per_unit";
                 tiered: "tiered";
-                rated: "rated";
-            }>;
+            }>>;
             unit_quantity: zod.ZodString;
             id: zod.ZodUUID;
             currency: zod.ZodString;
             type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             interval: zod.ZodEnum<{
                 none: "none";
@@ -84,7 +86,14 @@ export declare const CreditGrant: zod.ZodObject<{
             unit_amount: zod.ZodOptional<zod.ZodString>;
             active: zod.ZodBoolean;
         }, zod.z.core.$strict>>>;
-        price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+        price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+            one_time: "one_time";
+            recurring: "recurring";
+        }>>>;
+        usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
+        }>>>;
         operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
             new: "new";
             renew: "renew";
@@ -113,18 +122,20 @@ export declare const CreditGrant: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>;
-            billing_scheme: zod.ZodEnum<{
+            billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                 per_unit: "per_unit";
                 tiered: "tiered";
-                rated: "rated";
-            }>;
+            }>>;
             unit_quantity: zod.ZodString;
             id: zod.ZodUUID;
             currency: zod.ZodString;
             type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             interval: zod.ZodEnum<{
                 none: "none";

package/dist/canopy/v1/generated/validators/creditGrantList.zod.d.ts

@@ -62,18 +62,20 @@ export declare const CreditGrantList: zod.ZodObject<{
                     id: zod.ZodUUID;
                     name: zod.ZodString;
                 }, zod.z.core.$strict>;
-                billing_scheme: zod.ZodEnum<{
+                billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                     per_unit: "per_unit";
                     tiered: "tiered";
-                    rated: "rated";
-                }>;
+                }>>;
                 unit_quantity: zod.ZodString;
                 id: zod.ZodUUID;
                 currency: zod.ZodString;
                 type: zod.ZodEnum<{
-                    postpaid: "postpaid";
-                    prepaid: "prepaid";
                     one_time: "one_time";
+                    recurring: "recurring";
+                }>;
+                usage_type: zod.ZodEnum<{
+                    licensed: "licensed";
+                    metered: "metered";
                 }>;
                 interval: zod.ZodEnum<{
                     none: "none";
@@ -85,7 +87,14 @@ export declare const CreditGrantList: zod.ZodObject<{
                 unit_amount: zod.ZodOptional<zod.ZodString>;
                 active: zod.ZodBoolean;
             }, zod.z.core.$strict>>>;
-            price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+            price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+                one_time: "one_time";
+                recurring: "recurring";
+            }>>>;
+            usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
+            }>>>;
             operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
                 new: "new";
                 renew: "renew";
@@ -114,18 +123,20 @@ export declare const CreditGrantList: zod.ZodObject<{
                     id: zod.ZodUUID;
                     name: zod.ZodString;
                 }, zod.z.core.$strict>;
-                billing_scheme: zod.ZodEnum<{
+                billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                     per_unit: "per_unit";
                     tiered: "tiered";
-                    rated: "rated";
-                }>;
+                }>>;
                 unit_quantity: zod.ZodString;
                 id: zod.ZodUUID;
                 currency: zod.ZodString;
                 type: zod.ZodEnum<{
-                    postpaid: "postpaid";
-                    prepaid: "prepaid";
                     one_time: "one_time";
+                    recurring: "recurring";
+                }>;
+                usage_type: zod.ZodEnum<{
+                    licensed: "licensed";
+                    metered: "metered";
                 }>;
                 interval: zod.ZodEnum<{
                     none: "none";

package/dist/canopy/v1/generated/validators/creditGroup.zod.d.ts

@@ -54,18 +54,20 @@ export declare const CreditGroup: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>;
-            billing_scheme: zod.ZodEnum<{
+            billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                 per_unit: "per_unit";
                 tiered: "tiered";
-                rated: "rated";
-            }>;
+            }>>;
             unit_quantity: zod.ZodString;
             id: zod.ZodUUID;
             currency: zod.ZodString;
             type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             interval: zod.ZodEnum<{
                 none: "none";
@@ -77,7 +79,14 @@ export declare const CreditGroup: zod.ZodObject<{
             unit_amount: zod.ZodOptional<zod.ZodString>;
             active: zod.ZodBoolean;
         }, zod.z.core.$strict>>>;
-        price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+        price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+            one_time: "one_time";
+            recurring: "recurring";
+        }>>>;
+        usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
+        }>>>;
         operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
             new: "new";
             renew: "renew";
@@ -106,18 +115,20 @@ export declare const CreditGroup: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>;
-            billing_scheme: zod.ZodEnum<{
+            billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                 per_unit: "per_unit";
                 tiered: "tiered";
-                rated: "rated";
-            }>;
+            }>>;
             unit_quantity: zod.ZodString;
             id: zod.ZodUUID;
             currency: zod.ZodString;
             type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             interval: zod.ZodEnum<{
                 none: "none";

package/dist/canopy/v1/generated/validators/creditGroup.zod.js

@@ -34,7 +34,7 @@ import * as zod from "zod";
 import { Applicability } from "./applicability.zod.js";
 import { Money } from "./money.zod.js";
 export const CreditGroup = zod.strictObject({
-    applies_to: Applicability.describe("What the credit in this group may pay for. No restrictions means anything on the account."),
+    applies_to: Applicability.describe("What the credit in this group may pay for; no restrictions means anything on the account."),
     first_purchase_only: zod
         .boolean()
         .optional()

package/dist/canopy/v1/generated/validators/creditNote.zod.js

@@ -44,11 +44,11 @@ export const CreditNote = zod
         .nullable()
         .describe("When this note was voided; null while issued."),
     pre_payment_amount: Money.describe("The reduction of unpaid receivables. A void note no longer reduces what is due."),
-    post_payment_amount: Money.describe("The credited part of payments already received. This is not proof that its refund has completed."),
+    post_payment_amount: Money.describe("The credited part of payments already received; its refund may not have completed."),
     refund_id: zod
         .uuid()
         .nullable()
-        .describe("The refund to the original payment sources, or null when no paid amount was credited."),
+        .describe("The refund to the original payment sources; null when no paid amount was credited."),
     reason: zod
         .enum([
         "provisioning_failed",
@@ -60,6 +60,6 @@ export const CreditNote = zod
         "usage_true_up",
         "operator",
     ])
-        .describe("Why the note was issued. Notes from canceled, expired or failed orders carry the order's reason;\n`usage_true_up` returns a tier price reduction settled after the original invoice; `operator` is\nissued by Leaflow on request."),
+        .describe("Why the note was issued. Notes for canceled, expired or failed orders carry the order's reason; `usage_true_up` returns a tier price reduction settled after the original invoice; `operator` was issued on request."),
 })
-    .describe("An issued invoice reduction. Its credited amount is pre_payment_amount plus post_payment_amount. A paid credit records a return obligation; refund_id identifies its refund, whose outcome may still be pending. Original invoice amounts remain unchanged.");
+    .describe("A reduction of an issued invoice; the original invoice amounts do not change. The credited amount is pre_payment_amount plus post_payment_amount. A paid part creates a refund, identified by refund_id, whose outcome may still be pending.");

package/dist/canopy/v1/generated/validators/currency.zod.js

@@ -48,7 +48,7 @@ export const Currency = zod
         .int()
         .min(currencyExponentMin)
         .max(currencyExponentMax)
-        .describe("Decimal places of the currency, the ISO 4217 minor unit."),
+        .describe("Decimal places of the ISO 4217 minor unit."),
     name: zod.string().min(1).max(currencyNameMax),
     minimum_top_up: Money,
 })

package/dist/canopy/v1/generated/validators/discount.zod.d.ts

@@ -50,8 +50,8 @@ export declare const Discount: zod.ZodObject<{
         free_setup: "free_setup";
     }>;
     frequency: zod.ZodOptional<zod.ZodEnum<{
-        once: "once";
         recurring: "recurring";
+        once: "once";
         forever: "forever";
     }>>;
     frequency_duration: zod.ZodOptional<zod.ZodInt>;
@@ -83,18 +83,20 @@ export declare const Discount: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>;
-            billing_scheme: zod.ZodEnum<{
+            billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                 per_unit: "per_unit";
                 tiered: "tiered";
-                rated: "rated";
-            }>;
+            }>>;
             unit_quantity: zod.ZodString;
             id: zod.ZodUUID;
             currency: zod.ZodString;
             type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             interval: zod.ZodEnum<{
                 none: "none";
@@ -106,7 +108,14 @@ export declare const Discount: zod.ZodObject<{
             unit_amount: zod.ZodOptional<zod.ZodString>;
             active: zod.ZodBoolean;
         }, zod.z.core.$strict>>>;
-        price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+        price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+            one_time: "one_time";
+            recurring: "recurring";
+        }>>>;
+        usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
+        }>>>;
         operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
             new: "new";
             renew: "renew";
@@ -135,18 +144,20 @@ export declare const Discount: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>;
-            billing_scheme: zod.ZodEnum<{
+            billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                 per_unit: "per_unit";
                 tiered: "tiered";
-                rated: "rated";
-            }>;
+            }>>;
             unit_quantity: zod.ZodString;
             id: zod.ZodUUID;
             currency: zod.ZodString;
             type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             interval: zod.ZodEnum<{
                 none: "none";

package/dist/canopy/v1/generated/validators/discount.zod.js

@@ -41,13 +41,13 @@ export const Discount = zod
     promotion_code_id: zod.uuid().optional(),
     status: zod
         .enum(["scheduled", "active", "expired", "voided"])
-        .describe("`scheduled` before valid_from, `active` within the validity, `expired` after valid_until, or\n`voided` once Leaflow withdrew it."),
+        .describe("`scheduled` before valid_from, `active` within the validity, `expired` after valid_until, or `voided` once withdrawn."),
     voided_at: zod.iso.datetime({ offset: true }).optional(),
     type: zod.enum(["percentage", "fixed_amount", "price_override", "free_setup"]),
     frequency: zod
         .enum(["once", "recurring", "forever"])
         .optional()
-        .describe("Whether the discount continues on renewals of the purchased item. `once` applies only to the\npurchase or renewal that uses the coupon, `recurring` continues for `frequency_duration` billing\nperiods including the first, and `forever` continues on every renewal."),
+        .describe("Whether the discount continues on renewals: `once` applies only to the purchase or renewal using the coupon, `recurring` for `frequency_duration` periods including the first, `forever` on every renewal."),
     frequency_duration: zod.int().min(1).optional(),
     id: zod.uuid(),
     name: zod.string().optional(),
@@ -55,7 +55,7 @@ export const Discount = zod
     amount: Money.optional(),
     max_discount: Money.optional().describe("Caps a percentage discount."),
     currency: zod.string().optional(),
-    applies_to: Applicability.describe("What it may be used for. Absent means it applies to anything on the account,\nincluding setup fees and traffic."),
+    applies_to: Applicability.describe("What it may pay for. Absent means anything on the account, including setup fees and usage."),
     first_purchase_only: zod
         .boolean()
         .optional()
@@ -66,4 +66,4 @@ export const Discount = zod
         .nullish()
         .describe("Absent follows the coupon's own validity."),
 })
-    .describe("A coupon held on this account for a period. Within the period it applies without a code to purchases and\nto metered usage that the coupon covers.");
+    .describe("A coupon held by the account for a period, applying without a code to the purchases and metered usage it covers.");

package/dist/canopy/v1/generated/validators/discountList.zod.d.ts

@@ -51,8 +51,8 @@ export declare const DiscountList: zod.ZodObject<{
             free_setup: "free_setup";
         }>;
         frequency: zod.ZodOptional<zod.ZodEnum<{
-            once: "once";
             recurring: "recurring";
+            once: "once";
             forever: "forever";
         }>>;
         frequency_duration: zod.ZodOptional<zod.ZodInt>;
@@ -84,18 +84,20 @@ export declare const DiscountList: zod.ZodObject<{
                     id: zod.ZodUUID;
                     name: zod.ZodString;
                 }, zod.z.core.$strict>;
-                billing_scheme: zod.ZodEnum<{
+                billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                     per_unit: "per_unit";
                     tiered: "tiered";
-                    rated: "rated";
-                }>;
+                }>>;
                 unit_quantity: zod.ZodString;
                 id: zod.ZodUUID;
                 currency: zod.ZodString;
                 type: zod.ZodEnum<{
-                    postpaid: "postpaid";
-                    prepaid: "prepaid";
                     one_time: "one_time";
+                    recurring: "recurring";
+                }>;
+                usage_type: zod.ZodEnum<{
+                    licensed: "licensed";
+                    metered: "metered";
                 }>;
                 interval: zod.ZodEnum<{
                     none: "none";
@@ -107,7 +109,14 @@ export declare const DiscountList: zod.ZodObject<{
                 unit_amount: zod.ZodOptional<zod.ZodString>;
                 active: zod.ZodBoolean;
             }, zod.z.core.$strict>>>;
-            price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+            price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+                one_time: "one_time";
+                recurring: "recurring";
+            }>>>;
+            usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
+            }>>>;
             operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
                 new: "new";
                 renew: "renew";
@@ -136,18 +145,20 @@ export declare const DiscountList: zod.ZodObject<{
                     id: zod.ZodUUID;
                     name: zod.ZodString;
                 }, zod.z.core.$strict>;
-                billing_scheme: zod.ZodEnum<{
+                billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                     per_unit: "per_unit";
                     tiered: "tiered";
-                    rated: "rated";
-                }>;
+                }>>;
                 unit_quantity: zod.ZodString;
                 id: zod.ZodUUID;
                 currency: zod.ZodString;
                 type: zod.ZodEnum<{
-                    postpaid: "postpaid";
-                    prepaid: "prepaid";
                     one_time: "one_time";
+                    recurring: "recurring";
+                }>;
+                usage_type: zod.ZodEnum<{
+                    licensed: "licensed";
+                    metered: "metered";
                 }>;
                 interval: zod.ZodEnum<{
                     none: "none";

package/dist/canopy/v1/generated/validators/entitlement.zod.js

@@ -41,5 +41,5 @@ export const Entitlement = zod.strictObject({
     expires_at: zod.iso
         .datetime({ offset: true })
         .nullish()
-        .describe("When the subscription providing it ends. Absent for a metered subscription, which\nhas no end date."),
+        .describe("When the providing subscription ends. Absent for a metered subscription."),
 });

package/dist/canopy/v1/generated/validators/funds.zod.js

@@ -35,10 +35,10 @@ import { Money } from "./money.zod.js";
 export const Funds = zod
     .strictObject({
     available_balance_amount: Money.describe("Spendable balance after pending returns."),
-    usable_credit_amount: Money.describe("Currently effective credits eligible for the quoted purchases or postpaid usage. Each grant is counted once."),
-    restricted_credit_amount: Money.describe("Currently effective credits that cannot fund any quoted purchase or postpaid target. Unused eligible credits are not restricted."),
-    required_balance_amount: Money.describe("Minimum spendable balance needed after eligible credits, covering immediate charges and every new postpaid admission requirement."),
+    usable_credit_amount: Money.describe("Currently effective credits eligible for the quoted purchases or metered usage. Each grant is counted once."),
+    restricted_credit_amount: Money.describe("Currently effective credits that cannot fund any quoted purchase or metered target. Unused eligible credits are not restricted."),
+    required_balance_amount: Money.describe("Minimum spendable balance needed after eligible credits, covering immediate charges and every new metered purchase's admission requirement."),
     balance_shortfall_amount: Money.describe("Additional balance needed now. Zero means account funds satisfy this quote. No funds are reserved."),
     required_top_up_amount: Money.describe("Minimum recharge that covers the shortfall, respecting the currency minimum recharge and currency precision. Zero when no additional balance is needed."),
 })
-    .describe("Account funding for this purchase, calculated by Billing. Amounts use the enclosing response currency.\nCredit eligibility and all purchase requirements are already evaluated. Nothing is charged or reserved.\nA prepaid purchase may instead use an online payment method.\n");
+    .describe("Account funding for this purchase, calculated by Billing. Amounts use the enclosing response currency.\nCredit eligibility and all purchase requirements are already evaluated. Nothing is charged or reserved.\nA licensed purchase may instead be paid with an online payment method.\n");

package/dist/canopy/v1/generated/validators/invoice.zod.d.ts

@@ -55,7 +55,6 @@ export declare const Invoice: zod.ZodObject<{
         open: "open";
         draft: "draft";
         paid: "paid";
-        uncollectible: "uncollectible";
     }>;
     subtotal: zod.ZodOptional<zod.ZodString>;
     discount_amount: zod.ZodOptional<zod.ZodString>;

package/dist/canopy/v1/generated/validators/invoice.zod.js

@@ -38,7 +38,7 @@ export const Invoice = zod.strictObject({
     void_requested_at: zod.iso
         .datetime({ offset: true })
         .optional()
-        .describe("Collection has been stopped; any accepted return obligations are completed before final voiding."),
+        .describe("Collection has stopped; accepted return obligations are completed."),
     due_at: zod.iso.datetime({ offset: true }).optional(),
     amount_refunded: zod.string().optional(),
     tax_items: zod.array(TaxItem),
@@ -50,24 +50,24 @@ export const Invoice = zod.strictObject({
     subtotal: Money.optional().describe("Sum of the line amounts before discounts. Where prices include tax, the tax contained in\neach line's discounted amount is taken out here, so that total = subtotal -\ndiscount_amount + tax_amount always holds."),
     discount_amount: Money.optional().describe("Sum of the line discounts, taken off before tax."),
     tax_amount: Money.optional(),
-    credit_applied: Money.optional().describe("Successful credit-grant payments included in amount_paid. Does not reduce the receivable or tax base."),
-    total: Money.describe("Subtotal less discount plus tax. Balance and credit grants are payment sources, not reductions of the receivable."),
+    credit_applied: Money.optional().describe("Successful credit-grant payments, included in amount_paid; they do not reduce the receivable or tax base."),
+    total: Money.describe("Subtotal less discount plus tax. Balance and credit grants pay it; they do not reduce it."),
     amount_paid: Money.optional(),
-    pre_payment_credit_notes_amount: Money.describe("Issued, non-void credit notes that reduced unpaid receivables. Does not rewrite the original invoice total."),
-    post_payment_credit_notes_amount: Money.describe("Issued credit notes against payments already received. This is a return obligation, not evidence of completed refunds."),
-    amount_due: Money.describe("What is still collectible after unpaid credit notes and successful payments; never below zero. A draft has none; its total is the base price, and a payment preview shows what paying it would collect. A paid or void invoice has none either."),
+    pre_payment_credit_notes_amount: Money.describe("Issued credit notes that reduced unpaid receivables; the original invoice total is unchanged."),
+    post_payment_credit_notes_amount: Money.describe("Issued credit notes against payments already received; their refunds may not have completed."),
+    amount_due: Money.describe("What is still collectible after unpaid credit notes and successful payments; never below zero. Zero for a draft, whose total is the base price, and for a paid or void invoice."),
     period_start: zod.iso.datetime({ offset: true }).nullish(),
     period_end: zod.iso.datetime({ offset: true }).nullish().describe("Exclusive."),
     customer_name: zod
         .string()
         .optional()
-        .describe("Who this was billed to, as recorded when the invoice was issued. Later changes to\nthe account do not alter it."),
+        .describe("The billing details recorded when the invoice was issued."),
     customer_email: zod.string().optional(),
     customer_tax_id: zod.string().optional(),
     customer_tax_exempt: zod
         .enum(["none", "exempt", "reverse"])
         .optional()
-        .describe("How tax applied to the customer when the invoice was issued. `reverse` means no tax was\ncharged because the customer accounts for it under the reverse-charge mechanism."),
+        .describe("How tax applied to the customer when the invoice was issued; `reverse` means no tax was charged under the reverse-charge mechanism."),
     customer_address_line1: zod.string().optional(),
     customer_address_line2: zod.string().optional(),
     customer_address_city: zod.string().optional(),

package/dist/canopy/v1/generated/validators/invoiceItem.zod.d.ts

@@ -61,6 +61,7 @@ export declare const InvoiceItem: zod.ZodObject<{
     currency: zod.ZodString;
     period_start: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
     period_end: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+    dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
     prorations: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
         credited_invoice_item_id: zod.ZodUUID;
         description: zod.ZodString;