@checkoutpage/sdk 0.1.30 → 0.1.31

package/dist/index.d.mts

@@ -723,7 +723,7 @@ interface components {
              *     ]
              */
             fees?: components["schemas"]["PageFeeInput"][] | null;
-            /** @description Custom checkout fields to create. If one of your fields must be an `email` element and `required` must be true. Defaults to a name and email field if none are set. */
+            /** @description Custom checkout fields to create. When provided, at least one field must be an `email` element with `type` `email` and `required` `true`. When omitted, the page gets Name and Email address fields, plus a required billing Address on checkout and event pages. Forms get Name and Email address only. */
             fields?: components["schemas"]["FieldInput"][] | null;
             /**
              * @description Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior.
@@ -1200,7 +1200,7 @@ interface components {
              *     ]
              */
             fees?: components["schemas"]["PageFeeInput"][] | null;
-            /** @description Custom checkout fields to create. If one of your fields must be an `email` element and `required` must be true. Defaults to a name and email field if none are set. */
+            /** @description Custom checkout fields to create. When provided, at least one field must be an `email` element with `type` `email` and `required` `true`. When omitted, the page gets Name and Email address fields, plus a required billing Address on checkout and event pages. Forms get Name and Email address only. */
             fields?: components["schemas"]["FieldInput"][] | null;
             /**
              * @description Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior.
@@ -1517,7 +1517,7 @@ interface components {
              * @example <p>Welcome to our <strong>premium</strong> course!</p>
              */
             description?: string | null;
-            /** @description Custom checkout fields to create. If one of your fields must be an `email` element and `required` must be true. Defaults to a name and email field if none are set. */
+            /** @description Custom checkout fields to create. When provided, at least one field must be an `email` element with `type` `email` and `required` `true`. When omitted, the page gets Name and Email address fields, plus a required billing Address on checkout and event pages. Forms get Name and Email address only. */
             fields?: components["schemas"]["FieldInput"][] | null;
             /**
              * @description Array of file IDs for downloadable files. All file IDs must exist and belong to your account.
@@ -2161,6 +2161,10 @@ interface components {
             allowDynamicDescription?: boolean | null;
             /** @description Whether the compare-at price can be overridden via URL query parameters. */
             allowDynamicDiscountedFromPrice?: boolean | null;
+            /** @description Whether a price's label can be set dynamically via URL parameters. */
+            allowDynamicLabel?: boolean | null;
+            /** @description Whether a price can be preselected (and revealed if hidden) via URL parameters. */
+            allowDynamicPreselectedPrice?: boolean | null;
             /** @description Whether the price can be overridden via URL query parameters. */
             allowDynamicPrice?: boolean | null;
             /** @description Whether the redirect URL can be overridden via URL query parameters. */
@@ -3000,7 +3004,7 @@ interface components {
              */
             placeholder?: string | null;
             /**
-             * @description External reference ID for integration purposes.
+             * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
              * @example custom_field_1
              */
             reference?: string | null;
@@ -4293,7 +4297,7 @@ interface components {
                 /** @description Trial period in days. */
                 trialPeriodDays?: number | null;
             } | null;
-            /** @description Merchant-facing internal id (e.g. prc_ab12cd34). */
+            /** @description Merchant-facing internal id (e.g. price_one_time_fixed_5000). */
             reference?: string | null;
             /** @description One-time setup fee in cents. */
             setupFee?: number | null;
@@ -4396,7 +4400,7 @@ interface components {
                 /** @description Trial period in days for subscriptions. */
                 trialPeriodDays?: number | null;
             } | null;
-            /** @description Merchant-facing internal id (auto-generated when omitted). */
+            /** @description Merchant-facing internal id (SKU-like). Derived from the price data when omitted, e.g. price_one_time_fixed_5000. A price resent by id keeps its stored reference. */
             reference?: string | null;
             /** @description One-time setup fee in cents. */
             setupFee?: number | null;
@@ -4806,7 +4810,7 @@ interface components {
                 /** @description Price ids this variant group is scoped to. */
                 priceIds?: string[] | null;
                 /**
-                 * @description External reference ID. Defaults to a UUID v4.
+                 * @description External reference ID. Generated from the variant name when omitted.
                  * @example fd3136f8-da1f-4a4c-b381-32a097b60c38
                  */
                 reference?: string | null;
@@ -5284,7 +5288,7 @@ interface components {
                 /** @description Price ids this variant group is scoped to. Required when the product has multiple prices. */
                 priceIds?: (components["schemas"]["UniqueIdentifier"] & unknown)[] | null;
                 /**
-                 * @description External reference ID. Defaults to a UUID v4.
+                 * @description External reference ID. Generated from the variant name when omitted.
                  * @example fd3136f8-da1f-4a4c-b381-32a097b60c38
                  */
                 reference?: string | null;
@@ -5741,7 +5745,7 @@ interface components {
                 /** @description Trial period in days for subscriptions. */
                 trialPeriodDays?: number | null;
             } | null;
-            /** @description Merchant-facing internal id (auto-generated when omitted). */
+            /** @description Merchant-facing internal id (SKU-like). Derived from the price data when omitted, e.g. price_one_time_fixed_5000. A price resent by id keeps its stored reference. */
             reference?: string | null;
             /** @description One-time setup fee in cents. */
             setupFee?: number | null;
@@ -7380,13 +7384,14 @@ interface components {
              *     ]
              */
             fees?: components["schemas"]["PageFeeInput"][] | null;
+            /** @description Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior. Field references inside upsell/confirmation redirect steps resolve by `fieldId` (get current field IDs from the page detail response) — the create-time `fieldKey` string is rejected. */
             funnelSteps?: components["schemas"]["UpdateFunnelStepInput"][] | null;
             /**
              * @description Allow Google to index this page for search results. Defaults to `true`.
              * @example true
              */
             googleIndex?: boolean | null;
-            /** @description Array of images for the page gallery. All referenced file IDs must exist and belong to your account. */
+            /** @description Array of images for the page gallery. All referenced file IDs must exist and belong to your account. Pass null to clear the gallery. */
             imageIds?: (components["schemas"]["UniqueIdentifier"] & unknown)[] | null;
             invoiceSettings?: components["schemas"]["PageInvoiceSettingsInput"];
             /**
@@ -7394,14 +7399,14 @@ interface components {
              * @description Deprecated — superseded by `productData.limitSubscriptions.enabled`. Accepted and applied to the page's product.
              */
             limitSubscriptions?: {
-                enabled?: boolean;
+                enabled?: boolean | null;
             } | null;
             /**
              * @deprecated
              * @description Deprecated — superseded by `productData.limitSubscriptions.limitSubscriptionsStripe.enabled`. Accepted and applied to the page's product.
              */
             limitSubscriptionsStripe?: {
-                enabled?: boolean;
+                enabled?: boolean | null;
             } | null;
             /**
              * @description Locale code.
@@ -7494,15 +7499,66 @@ interface components {
              * @example false
              */
             redirectUrlInsideEmbed?: boolean | null;
+            /**
+             * @description Additional path parameters appended to the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` (the persisted field ID, from the page detail response) instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
+             * @example [
+             *       {
+             *         "fieldId": "507f1f77bcf86cd799439011",
+             *         "key": "fields"
+             *       },
+             *       {
+             *         "identifier": "orderId",
+             *         "key": "orderId"
+             *       }
+             *     ]
+             */
             redirectUrlPath?: {
-                fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                /**
+                 * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                 * @example 507f1f77bcf86cd799439011
+                 */
+                fieldId?: string | null;
+                /**
+                 * @description Static value or token identifier for this path segment. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                 * @example orderId
+                 */
                 identifier?: string | null;
+                /**
+                 * @description What this path segment resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                 * @example fields
+                 */
                 key?: string | null;
             }[] | null;
+            /**
+             * @description Query parameters for the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
+             * @example [
+             *       {
+             *         "fieldId": "507f1f77bcf86cd799439011",
+             *         "key": "fields",
+             *         "parameter": "name"
+             *       }
+             *     ]
+             */
             redirectUrlQuery?: {
-                fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                /**
+                 * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                 * @example 507f1f77bcf86cd799439011
+                 */
+                fieldId?: string | null;
+                /**
+                 * @description Static value or token identifier for this query parameter. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                 * @example orderId
+                 */
                 identifier?: string | null;
+                /**
+                 * @description What this query value resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                 * @example fields
+                 */
                 key?: string | null;
+                /**
+                 * @description The query string parameter name to set on the redirect URL.
+                 * @example email
+                 */
                 parameter?: string | null;
             }[] | null;
             /**
@@ -7552,23 +7608,23 @@ interface components {
              */
             slug?: string | null;
             /**
-             * @description Initial publication status. Defaults to "published" if not provided.
+             * @description Publication status of the page.
              * @example published
              * @enum {string|null}
              */
             status?: "published" | "draft" | "archived" | null;
             /**
-             * @description Tax configuration for this page.
+             * @description Tax configuration for this page. Defaults to Stripe Tax when omitted.
              * @example {
              *       "enabled": true,
-             *       "mode": "fixed"
+             *       "mode": "stripe"
              *     }
              */
             tax?: {
-                /** @description If enabled mode must be one of `fixed` or `stripe`. If disabled mode must be `none`. */
+                /** @description Whether to collect tax. When `true`, `mode` must be `fixed` or `stripe`. When `false`, `mode` must be `none` or omitted. */
                 enabled: boolean;
                 /**
-                 * @description Use mode `none` to not collect any tax. Use mode `fixed` for a fixed tax rate at checkout (configure the rate ID on `product.fixedTaxRateIds` for checkout pages or `eventDetails.fixedTaxRateIds` for event pages). Use mode `stripe` to enable Stripe tax, make sure Stripe tax is enabled globally in your Checkout Page account and configured in Stripe. You must also configure address fields in your page for the Stripe Tax calculation to be completed successfully. If omitted when `enabled` is `true`, defaults to `stripe`.
+                 * @description Tax collection mode. `stripe` — Stripe Tax calculates tax automatically based on the customer's address; requires address fields on the page and Stripe Tax configured in the account. `fixed` — a fixed tax rate is applied; configure the rate ID on `productData.fixedTaxRateIds` or rely on the account default rate. Call `list_tax_rates` first to find an existing rate. If no suitable rate exists, use `create_tax_rate` to create one first. `none` — no tax is collected. Defaults to `stripe` when `enabled` is `true`.
                  * @enum {string}
                  */
                 mode?: "none" | "fixed" | "stripe";
@@ -7675,7 +7731,7 @@ interface components {
              * @example <p>Welcome to our <strong>premium</strong> course!</p>
              */
             description?: string | null;
-            /** @description Event-specific details like type, dates, location, and update-only discount references. */
+            /** @description Event-specific details like type, dates, location. Ticket-specific discounts (`discounts[].ticketTypeIds`) must reference existing ticket types by `{ id }` — update cannot create new ticket types to key against, so the create-time `{ key }` form is rejected. */
             eventDetails?: {
                 /** @description Total event capacity. Omit for unlimited. */
                 capacity?: number | null;
@@ -7809,6 +7865,7 @@ interface components {
              *     ]
              */
             fees?: components["schemas"]["PageFeeInput"][] | null;
+            /** @description Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior. Field references inside upsell/confirmation redirect steps resolve by `fieldId` (get current field IDs from the page detail response) — the create-time `fieldKey` string is rejected. */
             funnelSteps?: components["schemas"]["UpdateFunnelStepInput"][] | null;
             /**
              * @description Allow Google to index this page for search results. Defaults to `true`.
@@ -7904,15 +7961,66 @@ interface components {
              * @example false
              */
             redirectUrlInsideEmbed?: boolean | null;
+            /**
+             * @description Additional path parameters appended to the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` (the persisted field ID, from the page detail response) instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
+             * @example [
+             *       {
+             *         "fieldId": "507f1f77bcf86cd799439011",
+             *         "key": "fields"
+             *       },
+             *       {
+             *         "identifier": "orderId",
+             *         "key": "orderId"
+             *       }
+             *     ]
+             */
             redirectUrlPath?: {
-                fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                /**
+                 * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                 * @example 507f1f77bcf86cd799439011
+                 */
+                fieldId?: string | null;
+                /**
+                 * @description Static value or token identifier for this path segment. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                 * @example orderId
+                 */
                 identifier?: string | null;
+                /**
+                 * @description What this path segment resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                 * @example fields
+                 */
                 key?: string | null;
             }[] | null;
+            /**
+             * @description Query parameters for the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
+             * @example [
+             *       {
+             *         "fieldId": "507f1f77bcf86cd799439011",
+             *         "key": "fields",
+             *         "parameter": "name"
+             *       }
+             *     ]
+             */
             redirectUrlQuery?: {
-                fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                /**
+                 * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                 * @example 507f1f77bcf86cd799439011
+                 */
+                fieldId?: string | null;
+                /**
+                 * @description Static value or token identifier for this query parameter. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                 * @example orderId
+                 */
                 identifier?: string | null;
+                /**
+                 * @description What this query value resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                 * @example fields
+                 */
                 key?: string | null;
+                /**
+                 * @description The query string parameter name to set on the redirect URL.
+                 * @example email
+                 */
                 parameter?: string | null;
             }[] | null;
             /**
@@ -8125,33 +8233,61 @@ interface components {
                  */
                 redirectUrl?: string | null;
                 /**
-                 * @description Optional path values appended to `redirectUrl`.
+                 * @description Optional path values appended to `redirectUrl`. To reference a field value, use `fieldId` (the persisted field ID, from the page detail response) — the create-time `fieldKey` string is rejected.
                  * @example [
                  *       {
-                 *         "identifier": "orderId",
-                 *         "key": "orderId"
+                 *         "fieldId": "507f1f77bcf86cd799439011",
+                 *         "key": "fields"
                  *       }
                  *     ]
                  */
                 redirectUrlPath?: {
-                    fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                    /**
+                     * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                     * @example 507f1f77bcf86cd799439011
+                     */
+                    fieldId?: string | null;
+                    /**
+                     * @description Static value or token identifier for this path segment. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                     * @example orderId
+                     */
                     identifier?: string | null;
+                    /**
+                     * @description What this path segment resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                     * @example fields
+                     */
                     key?: string | null;
                 }[] | null;
                 /**
-                 * @description Optional query parameters appended to `redirectUrl`.
+                 * @description Optional query parameters appended to `redirectUrl`. To reference a field value, use `fieldId` instead of the create-time `fieldKey`.
                  * @example [
                  *       {
-                 *         "identifier": "customer-email-field-id",
+                 *         "fieldId": "507f1f77bcf86cd799439011",
                  *         "key": "fields",
                  *         "parameter": "email"
                  *       }
                  *     ]
                  */
                 redirectUrlQuery?: {
-                    fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                    /**
+                     * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                     * @example 507f1f77bcf86cd799439011
+                     */
+                    fieldId?: string | null;
+                    /**
+                     * @description Static value or token identifier for this query parameter. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                     * @example orderId
+                     */
                     identifier?: string | null;
+                    /**
+                     * @description What this query value resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                     * @example fields
+                     */
                     key?: string | null;
+                    /**
+                     * @description The query string parameter name to set on the redirect URL.
+                     * @example email
+                     */
                     parameter?: string | null;
                 }[] | null;
             } | null;
@@ -8266,8 +8402,20 @@ interface components {
                      *     ]
                      */
                     path?: {
-                        fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                        /**
+                         * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                         * @example 507f1f77bcf86cd799439011
+                         */
+                        fieldId?: string | null;
+                        /**
+                         * @description Static value or token identifier for this path segment. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                         * @example orderId
+                         */
                         identifier?: string | null;
+                        /**
+                         * @description What this path segment resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                         * @example fields
+                         */
                         key?: string | null;
                     }[] | null;
                     /**
@@ -8281,9 +8429,25 @@ interface components {
                      *     ]
                      */
                     query?: {
-                        fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                        /**
+                         * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                         * @example 507f1f77bcf86cd799439011
+                         */
+                        fieldId?: string | null;
+                        /**
+                         * @description Static value or token identifier for this query parameter. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                         * @example orderId
+                         */
                         identifier?: string | null;
+                        /**
+                         * @description What this query value resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                         * @example fields
+                         */
                         key?: string | null;
+                        /**
+                         * @description The query string parameter name to set on the redirect URL.
+                         * @example email
+                         */
                         parameter?: string | null;
                     }[] | null;
                     /**
@@ -8511,7 +8675,7 @@ interface components {
                     /** @description Trial period in days for subscriptions. */
                     trialPeriodDays?: number | null;
                 } | null;
-                /** @description Merchant-facing internal id (auto-generated when omitted). */
+                /** @description Merchant-facing internal id (SKU-like). Derived from the price data when omitted, e.g. price_one_time_fixed_5000. A price resent by id keeps its stored reference. */
                 reference?: string | null;
                 /** @description One-time setup fee in cents. */
                 setupFee?: number | null;
@@ -8717,7 +8881,7 @@ interface components {
                 /** @description Price ids this variant group is scoped to. Required when the product has multiple prices. */
                 priceIds?: (components["schemas"]["UniqueIdentifier"] & unknown)[] | null;
                 /**
-                 * @description External reference ID. Defaults to a UUID v4.
+                 * @description External reference ID. Generated from the variant name when omitted.
                  * @example fd3136f8-da1f-4a4c-b381-32a097b60c38
                  */
                 reference?: string | null;
@@ -10135,7 +10299,7 @@ interface operations {
                      */
                     placeholder?: string | null;
                     /**
-                     * @description External reference ID for integration purposes.
+                     * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
                      * @example custom_field_1
                      */
                     reference?: string | null;
@@ -10361,8 +10525,10 @@ interface operations {
                 };
                 content: {
                     "application/json": {
-                        message: string;
-                        success: boolean;
+                        data: {
+                            message: string;
+                            success: boolean;
+                        };
                     };
                 };
             };
@@ -10602,7 +10768,7 @@ interface operations {
                      */
                     placeholder?: string | null;
                     /**
-                     * @description External reference ID for integration purposes.
+                     * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
                      * @example custom_field_1
                      */
                     reference?: string | null;
@@ -12022,7 +12188,7 @@ interface operations {
                      */
                     placeholder?: string | null;
                     /**
-                     * @description External reference ID for integration purposes.
+                     * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
                      * @example custom_field_1
                      */
                     reference?: string | null;
@@ -12248,8 +12414,10 @@ interface operations {
                 };
                 content: {
                     "application/json": {
-                        message: string;
-                        success: boolean;
+                        data: {
+                            message: string;
+                            success: boolean;
+                        };
                     };
                 };
             };
@@ -12489,7 +12657,7 @@ interface operations {
                      */
                     placeholder?: string | null;
                     /**
-                     * @description External reference ID for integration purposes.
+                     * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
                      * @example custom_field_1
                      */
                     reference?: string | null;
@@ -14097,6 +14265,7 @@ interface operations {
                             enabled?: boolean | null;
                         } | null;
                     } | null;
+                    /** @description Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior. Field references inside upsell/confirmation redirect steps resolve by `fieldId` (get current field IDs from the page detail response) — the create-time `fieldKey` string is rejected. */
                     funnelSteps?: components["schemas"]["UpdateFunnelStepInput"][] | null;
                     /**
                      * @description Allow Google to index this page for search results. Defaults to `true`.
@@ -14148,15 +14317,66 @@ interface operations {
                      * @example false
                      */
                     redirectUrlInsideEmbed?: boolean | null;
+                    /**
+                     * @description Additional path parameters appended to the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` (the persisted field ID, from the page detail response) instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
+                     * @example [
+                     *       {
+                     *         "fieldId": "507f1f77bcf86cd799439011",
+                     *         "key": "fields"
+                     *       },
+                     *       {
+                     *         "identifier": "orderId",
+                     *         "key": "orderId"
+                     *       }
+                     *     ]
+                     */
                     redirectUrlPath?: {
-                        fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                        /**
+                         * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                         * @example 507f1f77bcf86cd799439011
+                         */
+                        fieldId?: string | null;
+                        /**
+                         * @description Static value or token identifier for this path segment. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                         * @example orderId
+                         */
                         identifier?: string | null;
+                        /**
+                         * @description What this path segment resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                         * @example fields
+                         */
                         key?: string | null;
                     }[] | null;
+                    /**
+                     * @description Query parameters for the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
+                     * @example [
+                     *       {
+                     *         "fieldId": "507f1f77bcf86cd799439011",
+                     *         "key": "fields",
+                     *         "parameter": "name"
+                     *       }
+                     *     ]
+                     */
                     redirectUrlQuery?: {
-                        fieldId?: components["schemas"]["UniqueIdentifier"] & (string | null);
+                        /**
+                         * @description The persisted field's ID, as `fieldId`. Required when `key` is `fields`; on update, field references resolve by `fieldId` rather than the create-time `fieldKey` string, since update requests can't create new fields to key against. Get current field IDs from the page detail response. Rejected unless `key` is `fields`.
+                         * @example 507f1f77bcf86cd799439011
+                         */
+                        fieldId?: string | null;
+                        /**
+                         * @description Static value or token identifier for this query parameter. Required unless `key` is `fields` — in that case use `fieldId` instead and omit this. Rejected when `key` is `fields`.
+                         * @example orderId
+                         */
                         identifier?: string | null;
+                        /**
+                         * @description What this query value resolves to. Set to `fields` to reference a field value collected on the page (pair with `fieldId`); any other value is a static token name (pair with `identifier`).
+                         * @example fields
+                         */
                         key?: string | null;
+                        /**
+                         * @description The query string parameter name to set on the redirect URL.
+                         * @example email
+                         */
                         parameter?: string | null;
                     }[] | null;
                     /**
@@ -14175,7 +14395,7 @@ interface operations {
                      */
                     slug?: string | null;
                     /**
-                     * @description Initial publication status. Defaults to "published" if not provided.
+                     * @description Publication status of the page.
                      * @example published
                      * @enum {string|null}
                      */
@@ -14531,7 +14751,7 @@ interface operations {
                      */
                     placeholder?: string | null;
                     /**
-                     * @description External reference ID for integration purposes.
+                     * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
                      * @example custom_field_1
                      */
                     reference?: string | null;
@@ -14757,8 +14977,10 @@ interface operations {
                 };
                 content: {
                     "application/json": {
-                        message: string;
-                        success: boolean;
+                        data: {
+                            message: string;
+                            success: boolean;
+                        };
                     };
                 };
             };
@@ -14998,7 +15220,7 @@ interface operations {
                      */
                     placeholder?: string | null;
                     /**
-                     * @description External reference ID for integration purposes.
+                     * @description External reference ID for integration purposes. Generated from the field type or label when omitted.
                      * @example custom_field_1
                      */
                     reference?: string | null;
@@ -21641,9 +21863,7 @@ declare class CheckoutPageFieldsResource {
     create(pageId: string, params: CreateCheckoutPageFieldParams): Promise<CheckoutPageFieldResponse>;
     get(pageId: string, fieldId: string): Promise<CheckoutPageFieldResponse>;
     update(pageId: string, fieldId: string, params: UpdateCheckoutPageFieldParams): Promise<CheckoutPageFieldResponse>;
-    delete(pageId: string, fieldId: string): Promise<{
-        data: CheckoutPageFieldDeleteResponse;
-    }>;
+    delete(pageId: string, fieldId: string): Promise<CheckoutPageFieldDeleteResponse>;
 }
 declare class CheckoutPagesResource {
     readonly fields: CheckoutPageFieldsResource;
@@ -21663,9 +21883,7 @@ declare class EventFieldsResource {
     create(pageId: string, params: CreateEventFieldParams): Promise<EventFieldResponse>;
     get(pageId: string, fieldId: string): Promise<EventFieldResponse>;
     update(pageId: string, fieldId: string, params: UpdateEventFieldParams): Promise<EventFieldResponse>;
-    delete(pageId: string, fieldId: string): Promise<{
-        data: EventFieldDeleteResponse;
-    }>;
+    delete(pageId: string, fieldId: string): Promise<EventFieldDeleteResponse>;
 }
 declare class EventTicketTypesResource {
     private client;
@@ -21705,9 +21923,7 @@ declare class FormFieldsResource {
     create(pageId: string, params: CreateFormFieldParams): Promise<FormFieldResponse>;
     get(pageId: string, fieldId: string): Promise<FormFieldResponse>;
     update(pageId: string, fieldId: string, params: UpdateFormFieldParams): Promise<FormFieldResponse>;
-    delete(pageId: string, fieldId: string): Promise<{
-        data: FormFieldDeleteResponse;
-    }>;
+    delete(pageId: string, fieldId: string): Promise<FormFieldDeleteResponse>;
 }
 declare class FormsResource {
     private client;