@aventurevc/api-schemas 0.8.8 → 0.8.10

package/dist/billing/checkout-mutation.d.ts

@@ -7,10 +7,14 @@ declare const BillingCheckoutMutationSchemaDefinition: z.ZodObject<{
         PRO_YEARLY: "PRO_YEARLY";
         PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
     }>;
+    uiMode: z.ZodOptional<z.ZodEnum<{
+        ELEMENTS: "ELEMENTS";
+        HOSTED_PAGE: "HOSTED_PAGE";
+    }>>;
 }, z.core.$strip>;
 type BillingCheckoutMutationDefinition = z.infer<typeof BillingCheckoutMutationSchemaDefinition>;
 /**
- * Caller-selected plan for server-owned hosted Checkout creation.
+ * Caller-selected plan and Checkout presentation for server-owned Checkout creation.
  *
  * @openapiSchema BillingCheckoutMutation
  * @endpoint POST /v1/billing/checkout-sessions

package/dist/billing/checkout-mutation.js

@@ -1,12 +1,15 @@
 // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
 import { z } from "zod/v4";
+import { BillingCheckoutUiModeSchema } from "./checkout-ui-mode.js";
 import { BillingPlanTypeSchema } from "./plan-type.js";
 const BillingCheckoutMutationSchemaDefinition = z.object({
-    /** AI Plus or AI Pro plan to start through hosted Checkout */
+    /** AI Plus or AI Pro plan to start through Checkout */
     plan: BillingPlanTypeSchema,
+    /** How the caller presents Checkout; HOSTED_PAGE when omitted */
+    uiMode: BillingCheckoutUiModeSchema.optional(),
 });
 /**
- * Caller-selected plan for server-owned hosted Checkout creation.
+ * Caller-selected plan and Checkout presentation for server-owned Checkout creation.
  *
  * @openapiSchema BillingCheckoutMutation
  * @endpoint POST /v1/billing/checkout-sessions

package/dist/billing/checkout-ui-mode.d.ts

@@ -0,0 +1,16 @@
+import { z } from "zod/v4";
+/**
+ * HOSTED_PAGE redirects the browser to Stripe's page at url. ELEMENTS renders the Payment Element in the caller's page with Stripe.js initCheckout using clientSecret and publishableKey, then confirms there.
+ *
+ * @openapiSchema BillingCheckoutUiMode
+ * @endpoint POST /v1/billing/checkout-sessions
+ * @usedBySchema BillingCheckoutMutationSchema
+ * @contractShape billing.checkout-ui-mode
+ * @contractRole canonical
+ */
+export declare const BillingCheckoutUiModeSchema: z.ZodEnum<{
+    ELEMENTS: "ELEMENTS";
+    HOSTED_PAGE: "HOSTED_PAGE";
+}>;
+export type BillingCheckoutUiMode = z.infer<typeof BillingCheckoutUiModeSchema>;
+//# sourceMappingURL=checkout-ui-mode.d.ts.map

package/dist/billing/checkout-ui-mode.js

@@ -0,0 +1,13 @@
+// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
+import { z } from "zod/v4";
+/**
+ * HOSTED_PAGE redirects the browser to Stripe's page at url. ELEMENTS renders the Payment Element in the caller's page with Stripe.js initCheckout using clientSecret and publishableKey, then confirms there.
+ *
+ * @openapiSchema BillingCheckoutUiMode
+ * @endpoint POST /v1/billing/checkout-sessions
+ * @usedBySchema BillingCheckoutMutationSchema
+ * @contractShape billing.checkout-ui-mode
+ * @contractRole canonical
+ */
+export const BillingCheckoutUiModeSchema = z.enum(["HOSTED_PAGE", "ELEMENTS"]);
+//# sourceMappingURL=checkout-ui-mode.js.map

package/dist/billing/checkout.d.ts

@@ -1,5 +1,6 @@
 import { z } from "zod/v4";
 declare const BillingCheckoutSchemaDefinition: z.ZodObject<{
+    clientSecret: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     expiresAt: z.ZodISODateTime;
     plan: z.ZodEnum<{
         PLUS_MONTHLY: "PLUS_MONTHLY";
@@ -8,11 +9,12 @@ declare const BillingCheckoutSchemaDefinition: z.ZodObject<{
         PRO_YEARLY: "PRO_YEARLY";
         PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
     }>;
-    url: z.ZodString;
+    publishableKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 type BillingCheckoutDefinition = z.infer<typeof BillingCheckoutSchemaDefinition>;
 /**
- * Hosted Checkout destination and expiry without provider identifiers.
+ * Checkout Session destination or client secret and expiry without provider identifiers.
  *
  * @openapiSchema BillingCheckout
  * @endpoint POST /v1/billing/checkout-sessions

package/dist/billing/checkout.js

@@ -2,14 +2,18 @@
 import { z } from "zod/v4";
 import { BillingPlanTypeSchema } from "./plan-type.js";
 const BillingCheckoutSchemaDefinition = z.object({
-    /** When the Checkout page stops accepting payment */
+    /** Checkout Session client secret for Stripe.js initCheckout; set for ELEMENTS */
+    clientSecret: z.string().nullish(),
+    /** When the Checkout Session stops accepting payment */
     expiresAt: z.iso.datetime({ offset: true }),
     plan: BillingPlanTypeSchema,
-    /** Hosted Checkout page to open in a browser to pay */
-    url: z.string(),
+    /** Stripe publishable key that loads Stripe.js; set for ELEMENTS */
+    publishableKey: z.string().nullish(),
+    /** Hosted Checkout page to open in a browser; set for HOSTED_PAGE */
+    url: z.string().nullish(),
 });
 /**
- * Hosted Checkout destination and expiry without provider identifiers.
+ * Checkout Session destination or client secret and expiry without provider identifiers.
  *
  * @openapiSchema BillingCheckout
  * @endpoint POST /v1/billing/checkout-sessions

package/dist/billing/payment-method.d.ts

@@ -0,0 +1,16 @@
+import { z } from "zod/v4";
+/**
+ * Card on file that pays the subscription.
+ *
+ * @openapiSchema BillingPaymentMethod
+ * @endpoint POST /v1/billing/plan-change-previews
+ * @usedBySchema BillingPlanChangePreviewSchema
+ * @contractShape billing.payment-method
+ * @contractRole canonical
+ */
+export declare const BillingPaymentMethodSchema: z.ZodObject<{
+    brand: z.ZodString;
+    last4: z.ZodString;
+}, z.core.$strip>;
+export type BillingPaymentMethod = z.infer<typeof BillingPaymentMethodSchema>;
+//# sourceMappingURL=payment-method.d.ts.map

package/dist/billing/payment-method.js

@@ -0,0 +1,18 @@
+// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
+import { z } from "zod/v4";
+/**
+ * Card on file that pays the subscription.
+ *
+ * @openapiSchema BillingPaymentMethod
+ * @endpoint POST /v1/billing/plan-change-previews
+ * @usedBySchema BillingPlanChangePreviewSchema
+ * @contractShape billing.payment-method
+ * @contractRole canonical
+ */
+export const BillingPaymentMethodSchema = z.object({
+    /** Card brand as Stripe reports it */
+    brand: z.string(),
+    /** Last four digits of the card number */
+    last4: z.string(),
+});
+//# sourceMappingURL=payment-method.js.map

package/dist/billing/plan-change-mutation.d.ts

@@ -13,6 +13,7 @@ type BillingPlanChangeMutationDefinition = z.infer<typeof BillingPlanChangeMutat
  * Caller-selected plan for changing a continuing AI Plus or AI Pro subscription.
  *
  * @openapiSchema BillingPlanChangeMutation
+ * @endpoint POST /v1/billing/plan-change-previews
  * @endpoint POST /v1/billing/plan-changes
  * @contractShape billing.plan-change-mutation
  * @contractRole canonical

package/dist/billing/plan-change-mutation.js

@@ -9,6 +9,7 @@ const BillingPlanChangeMutationSchemaDefinition = z.object({
  * Caller-selected plan for changing a continuing AI Plus or AI Pro subscription.
  *
  * @openapiSchema BillingPlanChangeMutation
+ * @endpoint POST /v1/billing/plan-change-previews
  * @endpoint POST /v1/billing/plan-changes
  * @contractShape billing.plan-change-mutation
  * @contractRole canonical

package/dist/billing/plan-change-preview.d.ts

@@ -0,0 +1,35 @@
+import { z } from "zod/v4";
+declare const BillingPlanChangePreviewSchemaDefinition: z.ZodObject<{
+    amountDue: z.ZodNumber;
+    currency: z.ZodString;
+    effectiveAt: z.ZodISODateTime;
+    paymentMethod: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        brand: z.ZodString;
+        last4: z.ZodString;
+    }, z.core.$strip>>>;
+    plan: z.ZodEnum<{
+        PLUS_MONTHLY: "PLUS_MONTHLY";
+        PLUS_YEARLY: "PLUS_YEARLY";
+        PRO_MONTHLY: "PRO_MONTHLY";
+        PRO_YEARLY: "PRO_YEARLY";
+        PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
+    }>;
+    recurringPrice: z.ZodObject<{
+        cadence: z.ZodString;
+        currency: z.ZodString;
+        unitAmount: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type BillingPlanChangePreviewDefinition = z.infer<typeof BillingPlanChangePreviewSchemaDefinition>;
+/**
+ * Preview of POST /v1/billing/plan-changes for the same plan: the amount charged on confirmation, when the plan takes effect, the renewal price after it, and the card that pays.
+ *
+ * @openapiSchema BillingPlanChangePreview
+ * @endpoint POST /v1/billing/plan-change-previews
+ * @contractShape billing.plan-change-preview
+ * @contractRole canonical
+ */
+export declare const BillingPlanChangePreviewSchema: z.ZodType<BillingPlanChangePreviewDefinition>;
+export type BillingPlanChangePreview = z.infer<typeof BillingPlanChangePreviewSchema>;
+export {};
+//# sourceMappingURL=plan-change-preview.d.ts.map

package/dist/billing/plan-change-preview.js

@@ -0,0 +1,29 @@
+// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
+import { z } from "zod/v4";
+import { BillingPaymentMethodSchema } from "./payment-method.js";
+import { BillingPlanTypeSchema } from "./plan-type.js";
+import { BillingRecurringPriceSchema } from "./recurring-price.js";
+const BillingPlanChangePreviewSchemaDefinition = z.object({
+    /** Amount charged on confirmation in the currency's minor unit, after credit for unused time; 0 when the change waits for the period end */
+    amountDue: z.number().int(),
+    /** ISO 4217 currency code. */
+    currency: z.string(),
+    /** When the plan would take effect: now, or the current period end */
+    effectiveAt: z.iso.datetime({ offset: true }),
+    /** Card Stripe charges; absent when no card is on file */
+    paymentMethod: BillingPaymentMethodSchema.nullish(),
+    /** Plan the subscription would move to */
+    plan: BillingPlanTypeSchema,
+    /** Recurring charge after the change */
+    recurringPrice: BillingRecurringPriceSchema,
+});
+/**
+ * Preview of POST /v1/billing/plan-changes for the same plan: the amount charged on confirmation, when the plan takes effect, the renewal price after it, and the card that pays.
+ *
+ * @openapiSchema BillingPlanChangePreview
+ * @endpoint POST /v1/billing/plan-change-previews
+ * @contractShape billing.plan-change-preview
+ * @contractRole canonical
+ */
+export const BillingPlanChangePreviewSchema = BillingPlanChangePreviewSchemaDefinition;
+//# sourceMappingURL=plan-change-preview.js.map

package/dist/billing/plan-change.d.ts

@@ -1,6 +1,7 @@
 import { z } from "zod/v4";
 declare const BillingPlanChangeSchemaDefinition: z.ZodObject<{
     effectiveAt: z.ZodISODateTime;
+    paymentClientSecret: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     paymentUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     plan: z.ZodEnum<{
         PLUS_MONTHLY: "PLUS_MONTHLY";
@@ -9,6 +10,7 @@ declare const BillingPlanChangeSchemaDefinition: z.ZodObject<{
         PRO_YEARLY: "PRO_YEARLY";
         PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
     }>;
+    publishableKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 type BillingPlanChangeDefinition = z.infer<typeof BillingPlanChangeSchemaDefinition>;
 /**

package/dist/billing/plan-change.js

@@ -4,10 +4,14 @@ import { BillingPlanTypeSchema } from "./plan-type.js";
 const BillingPlanChangeSchemaDefinition = z.object({
     /** When the plan takes effect: now, or the current period end */
     effectiveAt: z.iso.datetime({ offset: true }),
+    /** PaymentIntent client secret of the same pending invoice, for Stripe.js to complete authentication or payment in the page; set exactly when paymentUrl is. */
+    paymentClientSecret: z.string().nullish(),
     /** Hosted invoice to pay when the upgrade's prorated charge needs the customer; the upgrade applies only after it is paid. Absent when no payment is pending. */
     paymentUrl: z.string().nullish(),
     /** Plan the subscription moves to */
     plan: BillingPlanTypeSchema,
+    /** Stripe publishable key for Stripe.js; set with paymentClientSecret */
+    publishableKey: z.string().nullish(),
 });
 /**
  * Plan change outcome: an upgrade applies now with a prorated invoice, a downgrade waits for the current period end.

package/dist/billing/plan-type.d.ts

@@ -6,11 +6,13 @@ import { z } from "zod/v4";
  * @endpoint GET /v1/billing/plans
  * @endpoint GET /v1/billing/subscription
  * @endpoint POST /v1/billing/checkout-sessions
+ * @endpoint POST /v1/billing/plan-change-previews
  * @endpoint POST /v1/billing/plan-changes
  * @usedBySchema BillingCatalogPlanSchema
  * @usedBySchema BillingCheckoutMutationSchema
  * @usedBySchema BillingCheckoutSchema
  * @usedBySchema BillingPlanChangeMutationSchema
+ * @usedBySchema BillingPlanChangePreviewSchema
  * @usedBySchema BillingPlanChangeSchema
  * @usedBySchema BillingSubscriptionSchema
  * @contractShape billing.plan-type

package/dist/billing/plan-type.js

@@ -7,11 +7,13 @@ import { z } from "zod/v4";
  * @endpoint GET /v1/billing/plans
  * @endpoint GET /v1/billing/subscription
  * @endpoint POST /v1/billing/checkout-sessions
+ * @endpoint POST /v1/billing/plan-change-previews
  * @endpoint POST /v1/billing/plan-changes
  * @usedBySchema BillingCatalogPlanSchema
  * @usedBySchema BillingCheckoutMutationSchema
  * @usedBySchema BillingCheckoutSchema
  * @usedBySchema BillingPlanChangeMutationSchema
+ * @usedBySchema BillingPlanChangePreviewSchema
  * @usedBySchema BillingPlanChangeSchema
  * @usedBySchema BillingSubscriptionSchema
  * @contractShape billing.plan-type

package/dist/billing/recurring-price.d.ts

@@ -2,6 +2,8 @@ import { z } from "zod/v4";
 /**
  * @openapiSchema BillingRecurringPrice
  * @endpoint GET /v1/billing/subscription
+ * @endpoint POST /v1/billing/plan-change-previews
+ * @usedBySchema BillingPlanChangePreviewSchema
  * @usedBySchema BillingSubscriptionSchema
  * @contractShape billing.recurring-price
  * @contractRole canonical

package/dist/billing/recurring-price.js

@@ -3,6 +3,8 @@ import { z } from "zod/v4";
 /**
  * @openapiSchema BillingRecurringPrice
  * @endpoint GET /v1/billing/subscription
+ * @endpoint POST /v1/billing/plan-change-previews
+ * @usedBySchema BillingPlanChangePreviewSchema
  * @usedBySchema BillingSubscriptionSchema
  * @contractShape billing.recurring-price
  * @contractRole canonical

package/dist/entity/logo-type.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Distinguishes square icon vs standard/horizontal entity logo
+ * Entity logo slot: SQUARE is the square icon read back as `core.image.logoSquare`; STANDARD is the horizontal wordmark read back as `core.image.logo`.
  *
  * @openapiSchema EntityLogoType
  * @endpoint GET /v1/entities/{entityId}/media/{mediaType}

package/dist/entity/logo-type.js

@@ -1,7 +1,7 @@
 // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
 import { z } from "zod/v4";
 /**
- * Distinguishes square icon vs standard/horizontal entity logo
+ * Entity logo slot: SQUARE is the square icon read back as `core.image.logoSquare`; STANDARD is the horizontal wordmark read back as `core.image.logo`.
  *
  * @openapiSchema EntityLogoType
  * @endpoint GET /v1/entities/{entityId}/media/{mediaType}

package/dist/openapi-component-manifest.js

@@ -100,15 +100,27 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
         modulePath: "billing/checkout-mutation",
         schemaName: "BillingCheckoutMutationSchema",
     },
+    BillingCheckoutUiMode: {
+        modulePath: "billing/checkout-ui-mode",
+        schemaName: "BillingCheckoutUiModeSchema",
+    },
     BillingCreditPackType: {
         modulePath: "billing/credit-pack-type",
         schemaName: "BillingCreditPackTypeSchema",
     },
+    BillingPaymentMethod: {
+        modulePath: "billing/payment-method",
+        schemaName: "BillingPaymentMethodSchema",
+    },
     BillingPlanChange: { modulePath: "billing/plan-change", schemaName: "BillingPlanChangeSchema" },
     BillingPlanChangeMutation: {
         modulePath: "billing/plan-change-mutation",
         schemaName: "BillingPlanChangeMutationSchema",
     },
+    BillingPlanChangePreview: {
+        modulePath: "billing/plan-change-preview",
+        schemaName: "BillingPlanChangePreviewSchema",
+    },
     BillingPlanType: { modulePath: "billing/plan-type", schemaName: "BillingPlanTypeSchema" },
     BillingPortal: { modulePath: "billing/portal", schemaName: "BillingPortalSchema" },
     BillingRecurringPrice: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventurevc/api-schemas",
-  "version": "0.8.8",
+  "version": "0.8.10",
   "private": false,
   "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
   "license": "Apache-2.0",