@usethrottle/api-client 5.2.0 → 5.4.0

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

@@ -200,6 +200,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -242,6 +243,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -271,7 +290,7 @@ export declare class OrdersService {
      * @param source
      * @param q Search order id, number, source, status, or metadata.
      * @param customerId
-     * @param subscriptionId Return only the orders this subscription billed (exact match on `subscriptionId`, or on the legacy `metadata.subscription_id` pointer). Covers renewals, plan-change charges and the signup order.
+     * @param subscriptionId Return only the orders linked to this subscription: through one of their lines (every subscription a checkout creates), `subscriptionId`, or the legacy `metadata.subscription_id` pointer. Covers the signup order, renewals and plan-change charges.
      * @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
@@ -389,6 +408,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -431,6 +451,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -460,7 +498,7 @@ export declare class OrdersService {
      * @param source
      * @param q Search order id, number, source, status, or metadata.
      * @param customerId
-     * @param subscriptionId Return only the orders this subscription billed (exact match on `subscriptionId`, or on the legacy `metadata.subscription_id` pointer). Covers renewals, plan-change charges and the signup order.
+     * @param subscriptionId Return only the orders linked to this subscription: through one of their lines (every subscription a checkout creates), `subscriptionId`, or the legacy `metadata.subscription_id` pointer. Covers the signup order, renewals and plan-change charges.
      * @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
@@ -586,6 +624,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -628,6 +667,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -817,6 +874,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -859,6 +917,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -995,6 +1071,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -1037,6 +1114,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -1176,6 +1271,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -1218,6 +1314,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -1357,6 +1471,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -1399,6 +1514,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -1539,6 +1672,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -1581,6 +1715,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -1730,6 +1882,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -1772,6 +1925,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -1911,6 +2082,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -1953,6 +2125,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -2098,6 +2288,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -2140,6 +2331,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -2279,6 +2488,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -2321,6 +2531,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -2457,6 +2685,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -2499,6 +2728,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */
@@ -2699,6 +2946,7 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
                 id?: string;
@@ -2741,6 +2989,24 @@ export declare class OrdersService {
                 total?: number;
                 imageUrl?: string | null;
                 deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
                 /**
                  * Arbitrary key-value metadata
                  */