@opusdns/api 1.117.0 → 1.119.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.2.0"
   },
   "name": "@opusdns/api",
-  "version": "1.117.0",
+  "version": "1.119.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -120,6 +120,7 @@ import type {
   WhitelabelOnboardingFailureCode,
   WhitelabelOnboardingFailureType,
   WhitelabelOnboardingStatus,
+  WhitelabelRenewalMode,
   ZoneIncludeField,
   ZoneSortField,
 } from './schemas';
@@ -2137,6 +2138,16 @@ export const WHITELABEL_ONBOARDING_STATUS_VALUES = [
   'terminated',
 ] as const satisfies ReadonlyArray<WhitelabelOnboardingStatus>;
 
+export const WHITELABEL_RENEWAL_MODE = {
+  RENEW: "renew",
+  EXPIRE: "expire",
+} as const satisfies Record<string, WhitelabelRenewalMode>;
+
+export const WHITELABEL_RENEWAL_MODE_VALUES = [
+  'renew',
+  'expire',
+] as const satisfies ReadonlyArray<WhitelabelRenewalMode>;
+
 export const ZONE_INCLUDE_FIELD = {
   TAGS: "tags",
 } as const satisfies Record<string, ZoneIncludeField>;

package/src/helpers/keys.ts

@@ -381,6 +381,7 @@ import type {
   RequestHistory,
   ReservedDomainsBase,
   RgpOperations,
+  SetRenewalModeReq,
   SetVanityNameserverSetDefaultRes,
   SldLength,
   StatusChanges,
@@ -438,6 +439,7 @@ import type {
   WhitelabelBrandingRecheck,
   WhitelabelBranding,
   WhitelabelPlusCreate,
+  WhitelabelSubscriptionInfo,
   WhitelabelUpgradeToPlus,
   WhoisBase,
   ZoneVanitySetUpdate,
@@ -5146,6 +5148,12 @@ export const KEYS_RGP_OPERATIONS = [
   KEY_RGP_OPERATIONS_REQUEST,
 ] as const satisfies (keyof RgpOperations)[];
 
+export const KEY_SET_RENEWAL_MODE_REQ_RENEWAL_MODE = 'renewal_mode' satisfies keyof SetRenewalModeReq;
+
+export const KEYS_SET_RENEWAL_MODE_REQ = [
+  KEY_SET_RENEWAL_MODE_REQ_RENEWAL_MODE,
+] as const satisfies (keyof SetRenewalModeReq)[];
+
 export const KEY_SET_VANITY_NAMESERVER_SET_DEFAULT_RES_VANITY_NAMESERVER_SET = 'vanity_nameserver_set' satisfies keyof SetVanityNameserverSetDefaultRes;
 
 export const KEYS_SET_VANITY_NAMESERVER_SET_DEFAULT_RES = [
@@ -5892,10 +5900,12 @@ export const KEYS_WHITELABEL_BASE_CREATE = [
 
 export const KEY_WHITELABEL_BRANDING_PATCH_ENABLED = 'enabled' satisfies keyof WhitelabelBrandingPatch;
 export const KEY_WHITELABEL_BRANDING_PATCH_LABEL = 'label' satisfies keyof WhitelabelBrandingPatch;
+export const KEY_WHITELABEL_BRANDING_PATCH_RENEWAL_MODE = 'renewal_mode' satisfies keyof WhitelabelBrandingPatch;
 
 export const KEYS_WHITELABEL_BRANDING_PATCH = [
   KEY_WHITELABEL_BRANDING_PATCH_ENABLED,
   KEY_WHITELABEL_BRANDING_PATCH_LABEL,
+  KEY_WHITELABEL_BRANDING_PATCH_RENEWAL_MODE,
 ] as const satisfies (keyof WhitelabelBrandingPatch)[];
 
 export const KEY_WHITELABEL_BRANDING_RECHECK_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelBrandingRecheck;
@@ -5919,6 +5929,7 @@ export const KEY_WHITELABEL_BRANDING_HOSTNAME = 'hostname' satisfies keyof White
 export const KEY_WHITELABEL_BRANDING_KEYCLOAK_CLIENT_ID = 'keycloak_client_id' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_ONBOARDING_STATUS = 'onboarding_status' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_ORGANIZATION_ID = 'organization_id' satisfies keyof WhitelabelBranding;
+export const KEY_WHITELABEL_BRANDING_SUBSCRIPTION = 'subscription' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_TIER = 'tier' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_UPDATED_ON = 'updated_on' satisfies keyof WhitelabelBranding;
 export const KEY_WHITELABEL_BRANDING_VERIFICATION_DOMAIN = 'verification_domain' satisfies keyof WhitelabelBranding;
@@ -5936,6 +5947,7 @@ export const KEYS_WHITELABEL_BRANDING = [
   KEY_WHITELABEL_BRANDING_KEYCLOAK_CLIENT_ID,
   KEY_WHITELABEL_BRANDING_ONBOARDING_STATUS,
   KEY_WHITELABEL_BRANDING_ORGANIZATION_ID,
+  KEY_WHITELABEL_BRANDING_SUBSCRIPTION,
   KEY_WHITELABEL_BRANDING_TIER,
   KEY_WHITELABEL_BRANDING_UPDATED_ON,
   KEY_WHITELABEL_BRANDING_VERIFICATION_DOMAIN,
@@ -5958,6 +5970,18 @@ export const KEYS_WHITELABEL_PLUS_CREATE = [
   KEY_WHITELABEL_PLUS_CREATE_TIER,
 ] as const satisfies (keyof WhitelabelPlusCreate)[];
 
+export const KEY_WHITELABEL_SUBSCRIPTION_INFO_EXPIRES_ON = 'expires_on' satisfies keyof WhitelabelSubscriptionInfo;
+export const KEY_WHITELABEL_SUBSCRIPTION_INFO_GRACE_PERIOD_ENDS_AT = 'grace_period_ends_at' satisfies keyof WhitelabelSubscriptionInfo;
+export const KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEW_SCHEDULED_AT = 'renew_scheduled_at' satisfies keyof WhitelabelSubscriptionInfo;
+export const KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEWAL_MODE = 'renewal_mode' satisfies keyof WhitelabelSubscriptionInfo;
+
+export const KEYS_WHITELABEL_SUBSCRIPTION_INFO = [
+  KEY_WHITELABEL_SUBSCRIPTION_INFO_EXPIRES_ON,
+  KEY_WHITELABEL_SUBSCRIPTION_INFO_GRACE_PERIOD_ENDS_AT,
+  KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEW_SCHEDULED_AT,
+  KEY_WHITELABEL_SUBSCRIPTION_INFO_RENEWAL_MODE,
+] as const satisfies (keyof WhitelabelSubscriptionInfo)[];
+
 export const KEY_WHITELABEL_UPGRADE_TO_PLUS_AUTH_SUBDOMAIN = 'auth_subdomain' satisfies keyof WhitelabelUpgradeToPlus;
 export const KEY_WHITELABEL_UPGRADE_TO_PLUS_DASHBOARD_SUBDOMAIN = 'dashboard_subdomain' satisfies keyof WhitelabelUpgradeToPlus;
 export const KEY_WHITELABEL_UPGRADE_TO_PLUS_HOSTNAME = 'hostname' satisfies keyof WhitelabelUpgradeToPlus;

package/src/helpers/requests.d.ts

@@ -49,6 +49,7 @@ import type {
   PreviewMailReq,
   PublicAuthRequestForm,
   PublicRoleAssignmentRequest,
+  SetRenewalModeReq,
   TagCreate,
   TagUpdate,
   UserCreate,
@@ -1120,6 +1121,13 @@ export type GET_VanityNameserverSetsBySetId_Request = {
 };
 export type GET_VanityNameserverSetsBySetId_Request_Path = GET_VanityNameserverSetsBySetId_Request['parameters']['path'];
 
+export type PATCH_VanityNameserverSetsBySetId_Request = {
+  parameters: operations['set_vanity_nameserver_set_renewal_mode_v1_vanity_nameserver_sets__set_id__patch']['parameters'];
+  requestBody: SetRenewalModeReq;
+};
+export type PATCH_VanityNameserverSetsBySetId_Request_Path = PATCH_VanityNameserverSetsBySetId_Request['parameters']['path'];
+export type PATCH_VanityNameserverSetsBySetId_Request_Body = PATCH_VanityNameserverSetsBySetId_Request['requestBody'];
+
 export type PATCH_VanityNameserverSetsBySetIdDefault_Request = {
   parameters: operations['set_vanity_nameserver_set_default_v1_vanity_nameserver_sets__set_id__default_patch']['parameters'];
 };
@@ -1171,6 +1179,9 @@ export type GET_WhitelabelBrandingEmailTemplates_Request = {
 export type POST_WhitelabelBrandingRecheck_Request = {
 };
 
+export type POST_WhitelabelBrandingRestore_Request = {
+};
+
 export type POST_WhitelabelBrandingTier_Request = {
   requestBody: WhitelabelUpgradeToPlus;
 };

package/src/helpers/responses.d.ts

@@ -1013,14 +1013,19 @@ export type PATCH_UsersByUserId_Response = PATCH_UsersByUserId_Response_200 | PA
 export type PATCH_UsersByUserId_Response_200 = UserPublicWithAttributes;
 export type PATCH_UsersByUserId_Response_422 = HTTPValidationError;
 
+export type PATCH_VanityNameserverSetsBySetId_Response = PATCH_VanityNameserverSetsBySetId_Response_200 | PATCH_VanityNameserverSetsBySetId_Response_422;
+
+export type PATCH_VanityNameserverSetsBySetId_Response_200 = VanityNameserverSetSummaryDTO;
+export type PATCH_VanityNameserverSetsBySetId_Response_422 = HTTPValidationError;
+
 export type PATCH_VanityNameserverSetsBySetIdDefault_Response = PATCH_VanityNameserverSetsBySetIdDefault_Response_200 | PATCH_VanityNameserverSetsBySetIdDefault_Response_422;
 
 export type PATCH_VanityNameserverSetsBySetIdDefault_Response_200 = SetVanityNameserverSetDefaultRes;
 export type PATCH_VanityNameserverSetsBySetIdDefault_Response_422 = HTTPValidationError;
 
-export type PATCH_WhitelabelBranding_Response = PATCH_WhitelabelBranding_Response_202 | PATCH_WhitelabelBranding_Response_422;
+export type PATCH_WhitelabelBranding_Response = PATCH_WhitelabelBranding_Response_200 | PATCH_WhitelabelBranding_Response_422;
 
-export type PATCH_WhitelabelBranding_Response_202 = WhitelabelBranding;
+export type PATCH_WhitelabelBranding_Response_200 = WhitelabelBranding;
 export type PATCH_WhitelabelBranding_Response_422 = HTTPValidationError;
 
 export type POST_AiConciergeConversations_Response = POST_AiConciergeConversations_Response_201 | POST_AiConciergeConversations_Response_401 | POST_AiConciergeConversations_Response_404 | POST_AiConciergeConversations_Response_422 | POST_AiConciergeConversations_Response_502;
@@ -1418,6 +1423,11 @@ export type POST_WhitelabelBrandingRecheck_Response = POST_WhitelabelBrandingRec
 export type POST_WhitelabelBrandingRecheck_Response_202 = WhitelabelBranding;
 export type POST_WhitelabelBrandingRecheck_Response_422 = HTTPValidationError;
 
+export type POST_WhitelabelBrandingRestore_Response = POST_WhitelabelBrandingRestore_Response_200 | POST_WhitelabelBrandingRestore_Response_422;
+
+export type POST_WhitelabelBrandingRestore_Response_200 = WhitelabelBranding;
+export type POST_WhitelabelBrandingRestore_Response_422 = HTTPValidationError;
+
 export type POST_WhitelabelBrandingTier_Response = POST_WhitelabelBrandingTier_Response_202 | POST_WhitelabelBrandingTier_Response_422;
 
 export type POST_WhitelabelBrandingTier_Response_202 = ProductCreateRes;

package/src/helpers/schemas.d.ts

@@ -499,6 +499,7 @@ export type RequestHistorySortField = components['schemas']['RequestHistorySortF
 export type ReservedDomainsBase = components['schemas']['ReservedDomainsBase'];
 export type ReservedSourceType = components['schemas']['ReservedSourceType'];
 export type RgpOperations = components['schemas']['RgpOperations'];
+export type SetRenewalModeReq = components['schemas']['SetRenewalModeReq'];
 export type SetVanityNameserverSetDefaultRes = components['schemas']['SetVanityNameserverSetDefaultRes'];
 export type SldLength = components['schemas']['SldLength'];
 export type SortOrder = components['schemas']['SortOrder'];
@@ -583,6 +584,8 @@ export type WhitelabelOnboardingFailureCode = components['schemas']['WhitelabelO
 export type WhitelabelOnboardingFailureType = components['schemas']['WhitelabelOnboardingFailureType'];
 export type WhitelabelOnboardingStatus = components['schemas']['WhitelabelOnboardingStatus'];
 export type WhitelabelPlusCreate = components['schemas']['WhitelabelPlusCreate'];
+export type WhitelabelRenewalMode = components['schemas']['WhitelabelRenewalMode'];
+export type WhitelabelSubscriptionInfo = components['schemas']['WhitelabelSubscriptionInfo'];
 export type WhitelabelUpgradeToPlus = components['schemas']['WhitelabelUpgradeToPlus'];
 export type WhoisBase = components['schemas']['WhoisBase'];
 export type ZoneIncludeField = components['schemas']['ZoneIncludeField'];

package/src/openapi.yaml

@@ -12642,6 +12642,16 @@ components:
           type: boolean
       title: RgpOperations
       type: object
+    SetRenewalModeReq:
+      properties:
+        renewal_mode:
+          $ref: '#/components/schemas/RenewalModeDTO'
+          description: expire cancels the set at period end (serves out the term),
+            renew un-cancels (resumes auto-renew)
+      required:
+      - renewal_mode
+      title: SetRenewalModeReq
+      type: object
     SetVanityNameserverSetDefaultRes:
       properties:
         vanity_nameserver_set:
@@ -14710,16 +14720,20 @@ components:
       title: WhitelabelBaseCreate
       type: object
     WhitelabelBrandingPatch:
-      description: 'Public patch body. Neither field is a purchase, so nothing here
-        touches the subscription or
-
-        its price: `label` moves the base subdomain to a different label (base tier
-        only - a plus
+      description: 'Public patch body. `label` moves the base subdomain to a different
+        label (base tier only - a
 
-        whitelabel is re-pointed by its hostnames through recheck), and `enabled`
+        plus whitelabel is re-pointed by its hostnames through recheck) and `enabled`
         starts or stops
 
-        serving it. At least one must be given.'
+        serving it - both applied asynchronously via the reconcile job, neither a
+        purchase. `renewal_mode`
+
+        sets the subscription''s auto-renew intent synchronously (EXPIRE = cancel
+        at period end, RENEW =
+
+        un-cancel); it is not a purchase either - no price change. At least one must
+        be given.'
       properties:
         enabled:
           anyOf:
@@ -14736,6 +14750,12 @@ components:
           description: New base-tier label; the hostnames become app.<label>.<suffix>
             / auth.<label>.<suffix>. Base tier only.
           title: Label
+        renewal_mode:
+          anyOf:
+          - $ref: '#/components/schemas/WhitelabelRenewalMode'
+          - type: 'null'
+          description: 'Set auto-renew intent: expire cancels at period end (serves
+            out the term), renew un-cancels'
       title: WhitelabelBrandingPatch
       type: object
     WhitelabelBrandingRecheck:
@@ -14830,6 +14850,10 @@ components:
           title: Organization Id
           type: string
           x-typeid-prefix: organization
+        subscription:
+          anyOf:
+          - $ref: '#/components/schemas/WhitelabelSubscriptionInfo'
+          - type: 'null'
         tier:
           $ref: '#/components/schemas/WhitelabelBrandingTier'
         updated_on:
@@ -14970,6 +14994,61 @@ components:
       - period
       title: WhitelabelPlusCreate
       type: object
+    WhitelabelRenewalMode:
+      description: 'Whether the whitelabel''s subscription auto-renews (RENEW) or
+        lapses at period end (EXPIRE,
+
+        i.e. cancelled). The customer''s renewal intent, stored on the row and mirrored
+        to the subscription
+
+        on change (like the domain object). Its own enum so the whitelabel model does
+        not depend on the
+
+        domain model; the wire values (renew/expire) match domains + vanity nameservers.'
+      enum:
+      - renew
+      - expire
+      title: WhitelabelRenewalMode
+      type: string
+    WhitelabelSubscriptionInfo:
+      description: 'The whitelabel''s billing-lifecycle state, a pass-through read
+        from the subscription at the api
+
+        layer (product-service owns it; the branding row does not). Grouped into its
+        own object so it
+
+        reads as one all-or-nothing block: the parent''s `subscription` is null when
+        the config has no live
+
+        subscription (still provisioning, or terminated). renewal_mode EXPIRE + expires_on
+        is how a
+
+        cancelled whitelabel reads: "cancelled, served until expires_on".'
+      properties:
+        expires_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Expires On
+        grace_period_ends_at:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Grace Period Ends At
+        renew_scheduled_at:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Renew Scheduled At
+        renewal_mode:
+          $ref: '#/components/schemas/WhitelabelRenewalMode'
+      required:
+      - renewal_mode
+      title: WhitelabelSubscriptionInfo
+      type: object
     WhitelabelUpgradeToPlus:
       additionalProperties: false
       description: 'Upgrade the whitelabel to the plus tier, served on the customer''s
@@ -15455,7 +15534,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-08-18-083544
+  version: 2026-08-18-090726
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -32298,6 +32377,49 @@ paths:
       - nameserver
       x-required-permissions:
       - vanity_ns:read
+    patch:
+      operationId: set_vanity_nameserver_set_renewal_mode_v1_vanity_nameserver_sets__set_id__patch
+      parameters:
+      - in: path
+        name: set_id
+        required: true
+        schema:
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+      - $ref: '#/components/parameters/DatetimeFormatHeader'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SetRenewalModeReq'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VanityNameserverSetSummaryDTO'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Set the vanity nameserver set's renewal mode (expire = cancel at period
+        end, renew = un-cancel)
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:manage
   /v1/vanity-nameserver-sets/{set_id}/default:
     patch:
       operationId: set_vanity_nameserver_set_default_v1_vanity_nameserver_sets__set_id__default_patch
@@ -32500,7 +32622,7 @@ paths:
               $ref: '#/components/schemas/WhitelabelBrandingPatch'
         required: true
       responses:
-        '202':
+        '200':
           content:
             application/json:
               schema:
@@ -32515,7 +32637,8 @@ paths:
       security:
       - OAuth2PasswordBearer: []
       - APIKeyHeader: []
-      summary: Change the organization's whitelabel branding config (relabel / enable)
+      summary: Change the organization's whitelabel branding config (relabel / enable
+        / renewal mode)
       tags:
       - whitelabel
       x-required-permissions:
@@ -32651,6 +32774,33 @@ paths:
       - whitelabel
       x-required-permissions:
       - whitelabel_branding:manage
+  /v1/whitelabel-branding/restore:
+    post:
+      operationId: restore_whitelabel_branding_v1_whitelabel_branding_restore_post
+      parameters:
+      - $ref: '#/components/parameters/DatetimeFormatHeader'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WhitelabelBrandingResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Restore a terminated whitelabel (re-enable and reprovision from the
+        preserved state)
+      tags:
+      - whitelabel
+      x-required-permissions:
+      - whitelabel_branding:manage
   /v1/whitelabel-branding/tier:
     post:
       operationId: upgrade_whitelabel_to_plus_v1_whitelabel_branding_tier_post

package/src/schema.d.ts

@@ -2856,7 +2856,8 @@ export interface paths {
         delete: operations["delete_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__delete"];
         options?: never;
         head?: never;
-        patch?: never;
+        /** Set the vanity nameserver set's renewal mode (expire = cancel at period end, renew = un-cancel) */
+        patch: operations["set_vanity_nameserver_set_renewal_mode_v1_vanity_nameserver_sets__set_id__patch"];
         trace?: never;
     };
     "/v1/vanity-nameserver-sets/{set_id}/default": {
@@ -2942,7 +2943,7 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        /** Change the organization's whitelabel branding config (relabel / enable) */
+        /** Change the organization's whitelabel branding config (relabel / enable / renewal mode) */
         patch: operations["patch_whitelabel_branding_v1_whitelabel_branding_patch"];
         trace?: never;
     };
@@ -2997,6 +2998,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/whitelabel-branding/restore": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Restore a terminated whitelabel (re-enable and reprovision from the preserved state) */
+        post: operations["restore_whitelabel_branding_v1_whitelabel_branding_restore_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/whitelabel-branding/tier": {
         parameters: {
             query?: never;
@@ -11232,6 +11250,11 @@ export interface components {
              */
             request: boolean;
         };
+        /** SetRenewalModeReq */
+        SetRenewalModeReq: {
+            /** @description expire cancels the set at period end (serves out the term), renew un-cancels (resumes auto-renew) */
+            renewal_mode: components["schemas"]["RenewalModeDTO"];
+        };
         /** SetVanityNameserverSetDefaultRes */
         SetVanityNameserverSetDefaultRes: {
             /** @description The set that is now the org's default (or unchanged set on a no-op 200). */
@@ -12695,10 +12718,11 @@ export interface components {
         };
         /**
          * WhitelabelBrandingPatch
-         * @description Public patch body. Neither field is a purchase, so nothing here touches the subscription or
-         *     its price: `label` moves the base subdomain to a different label (base tier only - a plus
-         *     whitelabel is re-pointed by its hostnames through recheck), and `enabled` starts or stops
-         *     serving it. At least one must be given.
+         * @description Public patch body. `label` moves the base subdomain to a different label (base tier only - a
+         *     plus whitelabel is re-pointed by its hostnames through recheck) and `enabled` starts or stops
+         *     serving it - both applied asynchronously via the reconcile job, neither a purchase. `renewal_mode`
+         *     sets the subscription's auto-renew intent synchronously (EXPIRE = cancel at period end, RENEW =
+         *     un-cancel); it is not a purchase either - no price change. At least one must be given.
          */
         WhitelabelBrandingPatch: {
             /**
@@ -12711,6 +12735,8 @@ export interface components {
              * @description New base-tier label; the hostnames become app.<label>.<suffix> / auth.<label>.<suffix>. Base tier only.
              */
             label?: string | null;
+            /** @description Set auto-renew intent: expire cancels at period end (serves out the term), renew un-cancels */
+            renewal_mode?: components["schemas"]["WhitelabelRenewalMode"] | null;
         };
         /**
          * WhitelabelBrandingRecheck
@@ -12761,6 +12787,7 @@ export interface components {
              * @example organization_01h45ytscbebyvny4gc8cr8ma2
              */
             organization_id: TypeId<"organization">;
+            subscription?: components["schemas"]["WhitelabelSubscriptionInfo"] | null;
             tier: components["schemas"]["WhitelabelBrandingTier"];
             /**
              * Updated On
@@ -12839,6 +12866,32 @@ export interface components {
              */
             tier: "plus";
         };
+        /**
+         * WhitelabelRenewalMode
+         * @description Whether the whitelabel's subscription auto-renews (RENEW) or lapses at period end (EXPIRE,
+         *     i.e. cancelled). The customer's renewal intent, stored on the row and mirrored to the subscription
+         *     on change (like the domain object). Its own enum so the whitelabel model does not depend on the
+         *     domain model; the wire values (renew/expire) match domains + vanity nameservers.
+         * @enum {string}
+         */
+        WhitelabelRenewalMode: "renew" | "expire";
+        /**
+         * WhitelabelSubscriptionInfo
+         * @description The whitelabel's billing-lifecycle state, a pass-through read from the subscription at the api
+         *     layer (product-service owns it; the branding row does not). Grouped into its own object so it
+         *     reads as one all-or-nothing block: the parent's `subscription` is null when the config has no live
+         *     subscription (still provisioning, or terminated). renewal_mode EXPIRE + expires_on is how a
+         *     cancelled whitelabel reads: "cancelled, served until expires_on".
+         */
+        WhitelabelSubscriptionInfo: {
+            /** Expires On */
+            expires_on?: Date | null;
+            /** Grace Period Ends At */
+            grace_period_ends_at?: Date | null;
+            /** Renew Scheduled At */
+            renew_scheduled_at?: Date | null;
+            renewal_mode: components["schemas"]["WhitelabelRenewalMode"];
+        };
         /**
          * WhitelabelUpgradeToPlus
          * @description Upgrade the whitelabel to the plus tier, served on the customer's own domain. This is NOT a
@@ -27033,6 +27086,47 @@ export interface operations {
             };
         };
     };
+    set_vanity_nameserver_set_renewal_mode_v1_vanity_nameserver_sets__set_id__patch: {
+        parameters: {
+            query?: never;
+            header?: {
+                /**
+                 * @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
+                 * @example rfc3339
+                 */
+                "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
+            };
+            path: {
+                set_id: TypeId<"vns">;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetRenewalModeReq"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["VanityNameserverSetSummaryDTO"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     set_vanity_nameserver_set_default_v1_vanity_nameserver_sets__set_id__default_patch: {
         parameters: {
             query?: never;
@@ -27278,7 +27372,7 @@ export interface operations {
         };
         responses: {
             /** @description Successful Response */
-            202: {
+            200: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -27410,6 +27504,41 @@ export interface operations {
             };
         };
     };
+    restore_whitelabel_branding_v1_whitelabel_branding_restore_post: {
+        parameters: {
+            query?: never;
+            header?: {
+                /**
+                 * @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
+                 * @example rfc3339
+                 */
+                "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WhitelabelBrandingResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     upgrade_whitelabel_to_plus_v1_whitelabel_branding_tier_post: {
         parameters: {
             query?: never;