@usethrottle/api-client 4.4.1 → 5.1.0

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

@@ -27,7 +27,7 @@ export declare class SubscriptionsService {
         /**
          * Billing interval
          */
-        interval: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+        interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
         /**
          * Subscription amount in the smallest currency unit (e.g. cents)
          */
@@ -56,14 +56,26 @@ 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?: 'hour' | 'day' | 'week' | 'month';
+        /**
+         * 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;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -91,8 +103,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -109,20 +148,21 @@ export declare class SubscriptionsService {
      * @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 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).
      * @param createdBefore ISO 8601 upper bound on creation time, EXCLUSIVE (created_at < value).
      * @returns any Default Response
      * @throws ApiError
      */
-    static getApiV1Subscriptions(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, customerId?: string, externalCustomerId?: string, status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing', interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly', q?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
+    static getApiV1Subscriptions(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, customerId?: string, externalCustomerId?: string, status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed', interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom', installment?: boolean, q?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
         data?: Array<{
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -150,8 +190,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         }>;
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -170,10 +237,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -201,8 +268,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -221,21 +315,29 @@ export declare class SubscriptionsService {
     static patchApiV1Subscriptions(id: string, requestBody: {
         planReference?: string;
         planName?: string;
-        interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+        interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
         /**
          * Amount in cents
          */
         amount?: number;
         taxAddress?: any | null;
         metadata?: Record<string, any>;
+        /**
+         * Cadence unit. Send with intervalCount instead of, or together with, interval.
+         */
+        intervalUnit?: 'hour' | 'day' | 'week' | 'month';
+        /**
+         * Cadence count: every N units. At most one year (8760 hours, 365 days, 52 weeks, 12 months).
+         */
+        intervalCount?: number;
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -263,8 +365,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -303,10 +432,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -334,8 +463,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -354,10 +510,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -385,8 +541,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -408,10 +591,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -439,8 +622,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -459,10 +669,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -490,8 +700,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -519,7 +756,7 @@ export declare class SubscriptionsService {
         /**
          * Billing interval for the new plan
          */
-        interval: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+        interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
         /**
          * Amount in the smallest currency unit (e.g. cents)
          */
@@ -528,14 +765,22 @@ export declare class SubscriptionsService {
          * When the plan change takes effect
          */
         effective: 'now' | 'period_end';
+        /**
+         * Cadence unit. Send with intervalCount instead of, or together with, interval.
+         */
+        intervalUnit?: 'hour' | 'day' | 'week' | 'month';
+        /**
+         * Cadence count: every N units. At most one year (8760 hours, 365 days, 52 weeks, 12 months).
+         */
+        intervalCount?: number;
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -568,8 +813,35 @@ export declare class SubscriptionsService {
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -598,10 +870,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -634,8 +906,35 @@ export declare class SubscriptionsService {
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -654,10 +953,10 @@ export declare class SubscriptionsService {
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -685,8 +984,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;
@@ -708,17 +1034,17 @@ export declare class SubscriptionsService {
          */
         atPeriodEnd?: boolean;
         /**
-         * Money to return alongside an immediate cancellation. `prorated` credits the unused part of the current period; `last_cycle` returns the whole last paid cycle. Rejected when atPeriodEnd is true.
+         * Money to return alongside an immediate cancellation. `prorated` credits the unused part of the current period, capped at what was actually paid for it — returns 422 invalid_state if nothing was taken for the current period. `last_cycle` returns the whole last paid cycle. Rejected when atPeriodEnd is true.
          */
         refund?: 'none' | 'prorated' | 'last_cycle';
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
             customerId?: string;
-            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+            status?: 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing' | 'unpaid' | 'completed';
             planReference?: string;
             planName?: string | null;
-            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly';
+            interval?: 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom';
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -746,8 +1072,35 @@ export declare class SubscriptionsService {
                 lastName?: string | null;
                 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.
+             */
+            pendingIntervalUnit?: 'hour' | 'day' | 'week' | 'month' | null;
+            pendingIntervalCount?: number | 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;
         };
         meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
             requestId?: string;
             pagination?: {
                 cursor?: string | null;