npm - @usethrottle/api-client - Versions diffs - 5.3.0 → 5.4.0 - Mend

@usethrottle/api-client 5.3.0 → 5.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

package/dist/generated/services/SubscriptionsService.d.ts CHANGED Viewed

@@ -25,9 +25,21 @@ export declare class SubscriptionsService {
          */
         planName?: string;
         /**
-         * Billing interval
+         * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
          */
         interval?: string;
+        /**
+         * Cadence unit. Send with intervalCount instead of, or together with, interval.
+         */
+        intervalUnit?: string;
+        /**
+         * Cadence count: every N units. At most one year (8760 hours, 365 days, 52 weeks, 12 months).
+         */
+        intervalCount?: number;
+        /**
+         * Makes this an installment plan of exactly this many payments (2 to 60). Cannot be combined with trialEnd or changed later.
+         */
+        totalPayments?: number;
         /**
          * Subscription amount in the smallest currency unit (e.g. cents)
          */
@@ -56,18 +68,6 @@ export declare class SubscriptionsService {
          * The order that paid for the first period. Links the two in both directions: the order gets `subscriptionId` (and the legacy `metadata.subscription_id`), and this subscription's first invoice gets `orderId`. Use this when you charged the signup yourself and created the subscription afterwards. 404 if the order does not exist in this application and environment.
          */
         orderId?: string;
-        /**
-         * Cadence unit. Send with intervalCount instead of, or together with, interval.
-         */
-        intervalUnit?: string;
-        /**
-         * Cadence count: every N units. At most one year (8760 hours, 365 days, 52 weeks, 12 months).
-         */
-        intervalCount?: number;
-        /**
-         * Makes this an installment plan of exactly this many payments (2 to 60). Cannot be combined with trialEnd or changed later.
-         */
-        totalPayments?: number;
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
@@ -75,7 +75,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -108,25 +131,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -151,7 +158,7 @@ export declare class SubscriptionsService {
      * @param customerId
      * @param externalCustomerId Filter by the merchant's own customer ID (the value passed as externalId on customer creation). Server resolves to the throttle customerId before filtering. Mutually exclusive with customerId.
      * @param status
-     * @param interval
+     * @param interval A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
      * @param installment true: only installment plans; false: only ongoing subscriptions
      * @param q Search subscription id, customer id, plan reference, plan name, status, interval, and metadata.
      * @param createdAfter ISO 8601 lower bound on creation time, EXCLUSIVE (created_at > value).
@@ -166,7 +173,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -199,25 +229,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -248,7 +262,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -281,25 +318,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -327,13 +348,10 @@ export declare class SubscriptionsService {
     static patchApiV1Subscriptions(id: string, requestBody: {
         planReference?: string;
         planName?: string;
-        interval?: string;
         /**
-         * Amount in cents
+         * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
          */
-        amount?: number;
-        taxAddress?: any | null;
-        metadata?: Record<string, any>;
+        interval?: string;
         /**
          * Cadence unit. Send with intervalCount instead of, or together with, interval.
          */
@@ -342,6 +360,12 @@ export declare class SubscriptionsService {
          * Cadence count: every N units. At most one year (8760 hours, 365 days, 52 weeks, 12 months).
          */
         intervalCount?: number;
+        /**
+         * Amount in cents
+         */
+        amount?: number;
+        taxAddress?: any | null;
+        metadata?: Record<string, any>;
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
@@ -349,7 +373,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -382,25 +429,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -451,7 +482,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -484,25 +538,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -533,24 +571,47 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
              */
-            amount?: number;
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
             /**
-             * #688 — number of seats. Per-seat price is amount; the period charge is amount × quantity.
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
              */
-            quantity?: number;
-            currency?: string;
-            currentPeriodStart?: string;
-            currentPeriodEnd?: string;
-            cancelAtPeriodEnd?: boolean;
-            failureCount?: number;
+            totalPayments?: number | null;
             /**
-             * Arbitrary key-value metadata
+             * Installment plans only: payments counted so far (charges and waived periods).
              */
-            metadata?: Record<string, any>;
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            amount?: number;
+            /**
+             * #688 — number of seats. Per-seat price is amount; the period charge is amount × quantity.
+             */
+            quantity?: number;
+            currency?: string;
+            currentPeriodStart?: string;
+            currentPeriodEnd?: string;
+            cancelAtPeriodEnd?: boolean;
+            failureCount?: number;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
             taxAddressSnapshot?: any | null;
             taxAddressSource?: string | null;
             createdAt?: string;
@@ -566,25 +627,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -618,7 +663,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -651,25 +719,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
-             */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -700,7 +752,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -733,25 +808,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
-             */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -786,17 +845,9 @@ export declare class SubscriptionsService {
          */
         planName?: string;
         /**
-         * Billing interval for the new plan
+         * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
          */
         interval?: string;
-        /**
-         * Amount in the smallest currency unit (e.g. cents)
-         */
-        amount: number;
-        /**
-         * When the plan change takes effect
-         */
-        effective: 'now' | 'period_end';
         /**
          * Cadence unit. Send with intervalCount instead of, or together with, interval.
          */
@@ -805,6 +856,14 @@ export declare class SubscriptionsService {
          * Cadence count: every N units. At most one year (8760 hours, 365 days, 52 weeks, 12 months).
          */
         intervalCount?: number;
+        /**
+         * Amount in the smallest currency unit (e.g. cents)
+         */
+        amount: number;
+        /**
+         * When the plan change takes effect
+         */
+        effective: 'now' | 'period_end';
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
@@ -812,7 +871,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -844,35 +926,19 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 company?: string | null;
             } | null;
-            proration?: {
-                creditCents?: number;
-                chargedCents?: number;
-                fullAmount?: number;
-            };
-            /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
             /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
             renewalIssue?: any | null;
+            proration?: {
+                creditCents?: number;
+                chargedCents?: number;
+                fullAmount?: number;
+            };
         };
         meta?: {
             /**
@@ -909,7 +975,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -941,35 +1030,19 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 company?: string | null;
             } | null;
-            proration?: {
-                creditCents?: number;
-                chargedCents?: number;
-                fullAmount?: number;
-            };
-            /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
             /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
             renewalIssue?: any | null;
+            proration?: {
+                creditCents?: number;
+                chargedCents?: number;
+                fullAmount?: number;
+            };
         };
         meta?: {
             /**
@@ -996,7 +1069,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1029,25 +1125,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
-             */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */
@@ -1088,7 +1168,30 @@ export declare class SubscriptionsService {
             status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
+            /**
+             * A named interval, or "custom" when intervalUnit/intervalCount describe any other cadence
+             */
             interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
+            /**
+             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
+             */
+            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            intervalCount?: number | null;
+            billingAnchorAt?: string | null;
+            /**
+             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             */
+            totalPayments?: number | null;
+            /**
+             * Installment plans only: payments counted so far (charges and waived periods).
+             */
+            paymentsMade?: number;
+            completedAt?: string | null;
+            /**
+             * Cadence unit of the scheduled plan change; null when none is scheduled.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | null;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1121,25 +1224,9 @@ export declare class SubscriptionsService {
                 company?: string | null;
             } | null;
             /**
-             * Cadence unit: every intervalCount of these. A named interval carries its shorthand (monthly → month).
-             */
-            intervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            intervalCount?: number | null;
-            billingAnchorAt?: string | null;
-            /**
-             * Installment plans only: the fixed number of payments. null for an ongoing subscription.
+             * The tax category frozen from the checkout line that created this subscription (its `metadata.taxCategory`). Every renewal is quoted and filed with it, and it survives plan changes. Null when the line had none: renewals then use the default category.
              */
-            totalPayments?: number | null;
-            /**
-             * Installment plans only: payments counted so far (charges and waived periods).
-             */
-            paymentsMade?: number;
-            completedAt?: string | null;
-            /**
-             * Cadence unit of the scheduled plan change; null when none is scheduled.
-             */
-            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
-            pendingIntervalCount?: number | null;
+            taxCategory?: string | null;
             /**
              * Read-only. Set by the renewal job when renewals are failing (system_error) or when a card was charged but the renewal could not be recorded (orphan_charge — renewals are paused until resolved).
              */