@usethrottle/api-client 4.3.0 → 4.4.0

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

@@ -116,6 +116,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -129,7 +139,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -139,6 +149,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -181,6 +192,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -246,7 +264,7 @@ export declare class OrdersService {
      * @param status
      * @param paymentStatus
      * @param type
-     * @param delivery Where the goods are. Derived from shipment and return records, not an order column: `in_transit` = something shipped and something has not arrived, `delivered` = every shipment arrived, `returned` = any items came back (a partial return included).
+     * @param delivery Where the goods are. Derived from shipment and return records, not an order column: `not_shipped` = nothing has left yet on an order that still owes goods (status `processing` or `partially_fulfilled`, no returns), `in_transit` = something shipped and something has not arrived, `delivered` = every shipment arrived, `returned` = any items came back (a partial return included).
      * @param source
      * @param q Search order id, number, source, status, or metadata.
      * @param customerId
@@ -256,7 +274,7 @@ export declare class OrdersService {
      * @returns any Default Response
      * @throws ApiError
      */
-    static getApiV1Orders(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
+    static getApiV1Orders(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'not_shipped' | 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
         data?: Array<{
             id?: string;
             workspaceId?: string;
@@ -284,6 +302,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -297,7 +325,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -307,6 +335,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -349,6 +378,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -414,7 +450,7 @@ export declare class OrdersService {
      * @param status
      * @param paymentStatus
      * @param type
-     * @param delivery Where the goods are. Derived from shipment and return records, not an order column: `in_transit` = something shipped and something has not arrived, `delivered` = every shipment arrived, `returned` = any items came back (a partial return included).
+     * @param delivery Where the goods are. Derived from shipment and return records, not an order column: `not_shipped` = nothing has left yet on an order that still owes goods (status `processing` or `partially_fulfilled`, no returns), `in_transit` = something shipped and something has not arrived, `delivered` = every shipment arrived, `returned` = any items came back (a partial return included).
      * @param source
      * @param q Search order id, number, source, status, or metadata.
      * @param customerId
@@ -424,9 +460,9 @@ export declare class OrdersService {
      * @returns any Default Response
      * @throws ApiError
      */
-    static getApiV1OrdersExportCsv(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<any>;
+    static getApiV1OrdersExportCsv(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired', type?: 'one_time' | 'recurring' | 'mixed', delivery?: 'not_shipped' | 'in_transit' | 'delivered' | 'returned', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<any>;
     /**
-     * Get an order by ID (includes line items)
+     * Get an order by ID (includes line items, plus `capturedAmount` and `refundedAmount`)
      * @param id
      * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
      * @returns any Default Response
@@ -460,6 +496,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -473,7 +519,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -483,6 +529,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -525,6 +572,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -573,6 +627,14 @@ export declare class OrdersService {
                  */
                 metadata?: Record<string, any>;
             }>;
+            /**
+             * What this order actually collected, before refunds. Not the same as `total` on a partially-paid order.
+             */
+            capturedAmount?: number;
+            /**
+             * How much of the captured money went back. `paymentStatus: "refunded"` says a full refund happened; this says how much it was.
+             */
+            refundedAmount?: number;
         };
         meta?: {
             requestId?: string;
@@ -662,6 +724,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -675,7 +747,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -685,6 +757,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -727,6 +800,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -819,6 +899,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -832,7 +922,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -842,6 +932,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -884,6 +975,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -979,6 +1077,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -992,7 +1100,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1002,6 +1110,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1044,6 +1153,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -1139,6 +1255,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1152,7 +1278,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1162,6 +1288,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1204,6 +1331,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -1300,6 +1434,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1313,7 +1457,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1323,6 +1467,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1365,6 +1510,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -1470,6 +1622,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1483,7 +1645,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1493,6 +1655,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1535,6 +1698,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -1593,7 +1763,7 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Write off the order's remaining balance. Money already captured stays captured; the buyer is never charged and no processor is contacted. `compAmount` is set to the balance outstanding and `total` drops by the same amount, so `paymentStatus` settles at `captured` and `displayStatus` reads "… · Comped".
+     * Write off the order's remaining balance. Money already captured stays captured; the buyer is never charged and no processor is contacted. `compAmount` is set to the balance outstanding; `total` is NOT reduced, because the order is still a sale of that size — the comp is a credit recorded against it. What the buyer owes is `total - compAmount`, so `paymentStatus` settles at `captured` and `displayStatus` reads "… · Comped".
      * @param id
      * @param requestBody
      * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
@@ -1630,6 +1800,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1643,7 +1823,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1653,6 +1833,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1695,6 +1876,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -1762,7 +1950,7 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Undo a comp. The order owes what it owed again: `compAmount` returns to 0, `total` is restored, and `paymentStatus` falls back out of `captured` on its own. Side effects of the comp are NOT rewound: an authorization voided at the processor cannot be un-voided, so collecting the restored balance needs a new payment, and a tax document voided or returned at the provider needs a manual re-file (`POST /v1/tax-documents/{id}/retry`).
+     * Undo a comp. The order owes what it owed again: `compAmount` returns to 0 (`total` never moved) and `paymentStatus` falls back out of `captured` on its own. Side effects of the comp are NOT rewound: an authorization voided at the processor cannot be un-voided, so collecting the restored balance needs a new payment, and a tax document voided or returned at the provider needs a manual re-file (`POST /v1/tax-documents/{id}/retry`).
      * @param id
      * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
      * @returns any Default Response
@@ -1796,6 +1984,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1809,7 +2007,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1819,6 +2017,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1861,6 +2060,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -1956,6 +2162,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -1969,7 +2185,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -1979,6 +2195,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -2021,6 +2238,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -2113,6 +2337,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -2126,7 +2360,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -2136,6 +2370,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -2178,6 +2413,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -2283,6 +2525,7 @@ export declare class OrdersService {
             actorType?: 'user' | 'system' | 'integration' | 'api_key';
             actorName?: string;
             reason?: string;
+            subscriptionId?: string;
         }>;
         meta?: {
             requestId?: string;
@@ -2327,6 +2570,16 @@ export declare class OrdersService {
             taxTotal?: number;
             buyerVatNumber?: string | null;
             taxReverseCharge?: boolean;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
@@ -2340,7 +2593,7 @@ export declare class OrdersService {
              */
             total?: number;
             /**
-             * Amount in cents (e.g. 1999 = $19.99)
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
              */
             compAmount?: number;
             compReason?: string | null;
@@ -2350,6 +2603,7 @@ export declare class OrdersService {
             holdReason?: string | null;
             heldAt?: string | null;
             heldBy?: string | null;
+            notes?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -2392,6 +2646,13 @@ export declare class OrdersService {
                 phone?: string;
                 email?: string;
             } | null;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                amount?: number;
+            } | null;
             customerId?: string | null;
             subscriptionId?: string | null;
             customer?: {
@@ -2450,7 +2711,7 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Refund the captured payment on an order
+     * Refund an order. Spread across its captured payments, newest capture first, when the order was paid in instalments.
      * @param id
      * @param requestBody
      * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
@@ -2459,7 +2720,7 @@ export declare class OrdersService {
      */
     static postApiV1OrdersRefund(id: string, requestBody: {
         /**
-         * Partial refund amount (defaults to full amount)
+         * Partial refund amount (defaults to everything still refundable on the order)
          */
         amount?: number;
         reason?: string;