@usethrottle/api-client 4.2.1 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -135,6 +135,10 @@ export declare class OrdersService {
135
135
  compReason?: string | null;
136
136
  compedAt?: string | null;
137
137
  compedBy?: string | null;
138
+ onHold?: boolean;
139
+ holdReason?: string | null;
140
+ heldAt?: string | null;
141
+ heldBy?: string | null;
138
142
  /**
139
143
  * Arbitrary key-value metadata
140
144
  */
@@ -178,6 +182,7 @@ export declare class OrdersService {
178
182
  email?: string;
179
183
  } | null;
180
184
  customerId?: string | null;
185
+ subscriptionId?: string | null;
181
186
  customer?: {
182
187
  id?: string;
183
188
  email?: string;
@@ -190,10 +195,40 @@ export declare class OrdersService {
190
195
  closedAt?: string | null;
191
196
  createdAt?: string;
192
197
  updatedAt?: string;
193
- onHold?: boolean;
194
- holdReason?: string | null;
195
- heldAt?: string | null;
196
- heldBy?: string | null;
198
+ lineItems?: Array<{
199
+ id?: string;
200
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
201
+ referenceId?: string | null;
202
+ name?: string;
203
+ description?: string | null;
204
+ /**
205
+ * Amount in cents (e.g. 1999 = $19.99)
206
+ */
207
+ unitPrice?: number;
208
+ quantity?: number;
209
+ /**
210
+ * Amount in cents (e.g. 1999 = $19.99)
211
+ */
212
+ subtotal?: number;
213
+ /**
214
+ * Amount in cents (e.g. 1999 = $19.99)
215
+ */
216
+ taxAmount?: number;
217
+ /**
218
+ * Amount in cents (e.g. 1999 = $19.99)
219
+ */
220
+ discountAmount?: number;
221
+ /**
222
+ * Amount in cents (e.g. 1999 = $19.99)
223
+ */
224
+ total?: number;
225
+ imageUrl?: string | null;
226
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
227
+ /**
228
+ * Arbitrary key-value metadata
229
+ */
230
+ metadata?: Record<string, any>;
231
+ }>;
197
232
  };
198
233
  meta?: {
199
234
  requestId?: string;
@@ -215,7 +250,7 @@ export declare class OrdersService {
215
250
  * @param source
216
251
  * @param q Search order id, number, source, status, or metadata.
217
252
  * @param customerId
218
- * @param subscriptionId Return only the orders this subscription billed (exact match on the order metadata `subscription_id` pointer). Covers renewals, plan-change charges and the signup order.
253
+ * @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.
219
254
  * @param createdAfter ISO 8601 lower bound on creation time, EXCLUSIVE (created_at > value).
220
255
  * @param createdBefore ISO 8601 upper bound on creation time, EXCLUSIVE (created_at < value).
221
256
  * @returns any Default Response
@@ -268,6 +303,10 @@ export declare class OrdersService {
268
303
  compReason?: string | null;
269
304
  compedAt?: string | null;
270
305
  compedBy?: string | null;
306
+ onHold?: boolean;
307
+ holdReason?: string | null;
308
+ heldAt?: string | null;
309
+ heldBy?: string | null;
271
310
  /**
272
311
  * Arbitrary key-value metadata
273
312
  */
@@ -311,6 +350,7 @@ export declare class OrdersService {
311
350
  email?: string;
312
351
  } | null;
313
352
  customerId?: string | null;
353
+ subscriptionId?: string | null;
314
354
  customer?: {
315
355
  id?: string;
316
356
  email?: string;
@@ -323,10 +363,40 @@ export declare class OrdersService {
323
363
  closedAt?: string | null;
324
364
  createdAt?: string;
325
365
  updatedAt?: string;
326
- onHold?: boolean;
327
- holdReason?: string | null;
328
- heldAt?: string | null;
329
- heldBy?: string | null;
366
+ lineItems?: Array<{
367
+ id?: string;
368
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
369
+ referenceId?: string | null;
370
+ name?: string;
371
+ description?: string | null;
372
+ /**
373
+ * Amount in cents (e.g. 1999 = $19.99)
374
+ */
375
+ unitPrice?: number;
376
+ quantity?: number;
377
+ /**
378
+ * Amount in cents (e.g. 1999 = $19.99)
379
+ */
380
+ subtotal?: number;
381
+ /**
382
+ * Amount in cents (e.g. 1999 = $19.99)
383
+ */
384
+ taxAmount?: number;
385
+ /**
386
+ * Amount in cents (e.g. 1999 = $19.99)
387
+ */
388
+ discountAmount?: number;
389
+ /**
390
+ * Amount in cents (e.g. 1999 = $19.99)
391
+ */
392
+ total?: number;
393
+ imageUrl?: string | null;
394
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
395
+ /**
396
+ * Arbitrary key-value metadata
397
+ */
398
+ metadata?: Record<string, any>;
399
+ }>;
330
400
  }>;
331
401
  meta?: {
332
402
  requestId?: string;
@@ -348,7 +418,7 @@ export declare class OrdersService {
348
418
  * @param source
349
419
  * @param q Search order id, number, source, status, or metadata.
350
420
  * @param customerId
351
- * @param subscriptionId Return only the orders this subscription billed (exact match on the order metadata `subscription_id` pointer). Covers renewals, plan-change charges and the signup order.
421
+ * @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.
352
422
  * @param createdAfter ISO 8601 lower bound on creation time, EXCLUSIVE (created_at > value).
353
423
  * @param createdBefore ISO 8601 upper bound on creation time, EXCLUSIVE (created_at < value).
354
424
  * @returns any Default Response
@@ -409,6 +479,10 @@ export declare class OrdersService {
409
479
  compReason?: string | null;
410
480
  compedAt?: string | null;
411
481
  compedBy?: string | null;
482
+ onHold?: boolean;
483
+ holdReason?: string | null;
484
+ heldAt?: string | null;
485
+ heldBy?: string | null;
412
486
  /**
413
487
  * Arbitrary key-value metadata
414
488
  */
@@ -452,6 +526,7 @@ export declare class OrdersService {
452
526
  email?: string;
453
527
  } | null;
454
528
  customerId?: string | null;
529
+ subscriptionId?: string | null;
455
530
  customer?: {
456
531
  id?: string;
457
532
  email?: string;
@@ -464,10 +539,40 @@ export declare class OrdersService {
464
539
  closedAt?: string | null;
465
540
  createdAt?: string;
466
541
  updatedAt?: string;
467
- onHold?: boolean;
468
- holdReason?: string | null;
469
- heldAt?: string | null;
470
- heldBy?: string | null;
542
+ lineItems?: Array<{
543
+ id?: string;
544
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
545
+ referenceId?: string | null;
546
+ name?: string;
547
+ description?: string | null;
548
+ /**
549
+ * Amount in cents (e.g. 1999 = $19.99)
550
+ */
551
+ unitPrice?: number;
552
+ quantity?: number;
553
+ /**
554
+ * Amount in cents (e.g. 1999 = $19.99)
555
+ */
556
+ subtotal?: number;
557
+ /**
558
+ * Amount in cents (e.g. 1999 = $19.99)
559
+ */
560
+ taxAmount?: number;
561
+ /**
562
+ * Amount in cents (e.g. 1999 = $19.99)
563
+ */
564
+ discountAmount?: number;
565
+ /**
566
+ * Amount in cents (e.g. 1999 = $19.99)
567
+ */
568
+ total?: number;
569
+ imageUrl?: string | null;
570
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
571
+ /**
572
+ * Arbitrary key-value metadata
573
+ */
574
+ metadata?: Record<string, any>;
575
+ }>;
471
576
  };
472
577
  meta?: {
473
578
  requestId?: string;
@@ -576,6 +681,10 @@ export declare class OrdersService {
576
681
  compReason?: string | null;
577
682
  compedAt?: string | null;
578
683
  compedBy?: string | null;
684
+ onHold?: boolean;
685
+ holdReason?: string | null;
686
+ heldAt?: string | null;
687
+ heldBy?: string | null;
579
688
  /**
580
689
  * Arbitrary key-value metadata
581
690
  */
@@ -619,6 +728,7 @@ export declare class OrdersService {
619
728
  email?: string;
620
729
  } | null;
621
730
  customerId?: string | null;
731
+ subscriptionId?: string | null;
622
732
  customer?: {
623
733
  id?: string;
624
734
  email?: string;
@@ -631,10 +741,40 @@ export declare class OrdersService {
631
741
  closedAt?: string | null;
632
742
  createdAt?: string;
633
743
  updatedAt?: string;
634
- onHold?: boolean;
635
- holdReason?: string | null;
636
- heldAt?: string | null;
637
- heldBy?: string | null;
744
+ lineItems?: Array<{
745
+ id?: string;
746
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
747
+ referenceId?: string | null;
748
+ name?: string;
749
+ description?: string | null;
750
+ /**
751
+ * Amount in cents (e.g. 1999 = $19.99)
752
+ */
753
+ unitPrice?: number;
754
+ quantity?: number;
755
+ /**
756
+ * Amount in cents (e.g. 1999 = $19.99)
757
+ */
758
+ subtotal?: number;
759
+ /**
760
+ * Amount in cents (e.g. 1999 = $19.99)
761
+ */
762
+ taxAmount?: number;
763
+ /**
764
+ * Amount in cents (e.g. 1999 = $19.99)
765
+ */
766
+ discountAmount?: number;
767
+ /**
768
+ * Amount in cents (e.g. 1999 = $19.99)
769
+ */
770
+ total?: number;
771
+ imageUrl?: string | null;
772
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
773
+ /**
774
+ * Arbitrary key-value metadata
775
+ */
776
+ metadata?: Record<string, any>;
777
+ }>;
638
778
  };
639
779
  meta?: {
640
780
  requestId?: string;
@@ -698,6 +838,10 @@ export declare class OrdersService {
698
838
  compReason?: string | null;
699
839
  compedAt?: string | null;
700
840
  compedBy?: string | null;
841
+ onHold?: boolean;
842
+ holdReason?: string | null;
843
+ heldAt?: string | null;
844
+ heldBy?: string | null;
701
845
  /**
702
846
  * Arbitrary key-value metadata
703
847
  */
@@ -741,6 +885,7 @@ export declare class OrdersService {
741
885
  email?: string;
742
886
  } | null;
743
887
  customerId?: string | null;
888
+ subscriptionId?: string | null;
744
889
  customer?: {
745
890
  id?: string;
746
891
  email?: string;
@@ -753,10 +898,40 @@ export declare class OrdersService {
753
898
  closedAt?: string | null;
754
899
  createdAt?: string;
755
900
  updatedAt?: string;
756
- onHold?: boolean;
757
- holdReason?: string | null;
758
- heldAt?: string | null;
759
- heldBy?: string | null;
901
+ lineItems?: Array<{
902
+ id?: string;
903
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
904
+ referenceId?: string | null;
905
+ name?: string;
906
+ description?: string | null;
907
+ /**
908
+ * Amount in cents (e.g. 1999 = $19.99)
909
+ */
910
+ unitPrice?: number;
911
+ quantity?: number;
912
+ /**
913
+ * Amount in cents (e.g. 1999 = $19.99)
914
+ */
915
+ subtotal?: number;
916
+ /**
917
+ * Amount in cents (e.g. 1999 = $19.99)
918
+ */
919
+ taxAmount?: number;
920
+ /**
921
+ * Amount in cents (e.g. 1999 = $19.99)
922
+ */
923
+ discountAmount?: number;
924
+ /**
925
+ * Amount in cents (e.g. 1999 = $19.99)
926
+ */
927
+ total?: number;
928
+ imageUrl?: string | null;
929
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
930
+ /**
931
+ * Arbitrary key-value metadata
932
+ */
933
+ metadata?: Record<string, any>;
934
+ }>;
760
935
  };
761
936
  meta?: {
762
937
  requestId?: string;
@@ -823,6 +998,10 @@ export declare class OrdersService {
823
998
  compReason?: string | null;
824
999
  compedAt?: string | null;
825
1000
  compedBy?: string | null;
1001
+ onHold?: boolean;
1002
+ holdReason?: string | null;
1003
+ heldAt?: string | null;
1004
+ heldBy?: string | null;
826
1005
  /**
827
1006
  * Arbitrary key-value metadata
828
1007
  */
@@ -866,6 +1045,7 @@ export declare class OrdersService {
866
1045
  email?: string;
867
1046
  } | null;
868
1047
  customerId?: string | null;
1048
+ subscriptionId?: string | null;
869
1049
  customer?: {
870
1050
  id?: string;
871
1051
  email?: string;
@@ -878,10 +1058,40 @@ export declare class OrdersService {
878
1058
  closedAt?: string | null;
879
1059
  createdAt?: string;
880
1060
  updatedAt?: string;
881
- onHold?: boolean;
882
- holdReason?: string | null;
883
- heldAt?: string | null;
884
- heldBy?: string | null;
1061
+ lineItems?: Array<{
1062
+ id?: string;
1063
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
1064
+ referenceId?: string | null;
1065
+ name?: string;
1066
+ description?: string | null;
1067
+ /**
1068
+ * Amount in cents (e.g. 1999 = $19.99)
1069
+ */
1070
+ unitPrice?: number;
1071
+ quantity?: number;
1072
+ /**
1073
+ * Amount in cents (e.g. 1999 = $19.99)
1074
+ */
1075
+ subtotal?: number;
1076
+ /**
1077
+ * Amount in cents (e.g. 1999 = $19.99)
1078
+ */
1079
+ taxAmount?: number;
1080
+ /**
1081
+ * Amount in cents (e.g. 1999 = $19.99)
1082
+ */
1083
+ discountAmount?: number;
1084
+ /**
1085
+ * Amount in cents (e.g. 1999 = $19.99)
1086
+ */
1087
+ total?: number;
1088
+ imageUrl?: string | null;
1089
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1090
+ /**
1091
+ * Arbitrary key-value metadata
1092
+ */
1093
+ metadata?: Record<string, any>;
1094
+ }>;
885
1095
  };
886
1096
  meta?: {
887
1097
  requestId?: string;
@@ -948,6 +1158,10 @@ export declare class OrdersService {
948
1158
  compReason?: string | null;
949
1159
  compedAt?: string | null;
950
1160
  compedBy?: string | null;
1161
+ onHold?: boolean;
1162
+ holdReason?: string | null;
1163
+ heldAt?: string | null;
1164
+ heldBy?: string | null;
951
1165
  /**
952
1166
  * Arbitrary key-value metadata
953
1167
  */
@@ -991,6 +1205,7 @@ export declare class OrdersService {
991
1205
  email?: string;
992
1206
  } | null;
993
1207
  customerId?: string | null;
1208
+ subscriptionId?: string | null;
994
1209
  customer?: {
995
1210
  id?: string;
996
1211
  email?: string;
@@ -1003,10 +1218,40 @@ export declare class OrdersService {
1003
1218
  closedAt?: string | null;
1004
1219
  createdAt?: string;
1005
1220
  updatedAt?: string;
1006
- onHold?: boolean;
1007
- holdReason?: string | null;
1008
- heldAt?: string | null;
1009
- heldBy?: string | null;
1221
+ lineItems?: Array<{
1222
+ id?: string;
1223
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
1224
+ referenceId?: string | null;
1225
+ name?: string;
1226
+ description?: string | null;
1227
+ /**
1228
+ * Amount in cents (e.g. 1999 = $19.99)
1229
+ */
1230
+ unitPrice?: number;
1231
+ quantity?: number;
1232
+ /**
1233
+ * Amount in cents (e.g. 1999 = $19.99)
1234
+ */
1235
+ subtotal?: number;
1236
+ /**
1237
+ * Amount in cents (e.g. 1999 = $19.99)
1238
+ */
1239
+ taxAmount?: number;
1240
+ /**
1241
+ * Amount in cents (e.g. 1999 = $19.99)
1242
+ */
1243
+ discountAmount?: number;
1244
+ /**
1245
+ * Amount in cents (e.g. 1999 = $19.99)
1246
+ */
1247
+ total?: number;
1248
+ imageUrl?: string | null;
1249
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1250
+ /**
1251
+ * Arbitrary key-value metadata
1252
+ */
1253
+ metadata?: Record<string, any>;
1254
+ }>;
1010
1255
  };
1011
1256
  meta?: {
1012
1257
  requestId?: string;
@@ -1074,6 +1319,10 @@ export declare class OrdersService {
1074
1319
  compReason?: string | null;
1075
1320
  compedAt?: string | null;
1076
1321
  compedBy?: string | null;
1322
+ onHold?: boolean;
1323
+ holdReason?: string | null;
1324
+ heldAt?: string | null;
1325
+ heldBy?: string | null;
1077
1326
  /**
1078
1327
  * Arbitrary key-value metadata
1079
1328
  */
@@ -1117,6 +1366,7 @@ export declare class OrdersService {
1117
1366
  email?: string;
1118
1367
  } | null;
1119
1368
  customerId?: string | null;
1369
+ subscriptionId?: string | null;
1120
1370
  customer?: {
1121
1371
  id?: string;
1122
1372
  email?: string;
@@ -1129,6 +1379,40 @@ export declare class OrdersService {
1129
1379
  closedAt?: string | null;
1130
1380
  createdAt?: string;
1131
1381
  updatedAt?: string;
1382
+ lineItems?: Array<{
1383
+ id?: string;
1384
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
1385
+ referenceId?: string | null;
1386
+ name?: string;
1387
+ description?: string | null;
1388
+ /**
1389
+ * Amount in cents (e.g. 1999 = $19.99)
1390
+ */
1391
+ unitPrice?: number;
1392
+ quantity?: number;
1393
+ /**
1394
+ * Amount in cents (e.g. 1999 = $19.99)
1395
+ */
1396
+ subtotal?: number;
1397
+ /**
1398
+ * Amount in cents (e.g. 1999 = $19.99)
1399
+ */
1400
+ taxAmount?: number;
1401
+ /**
1402
+ * Amount in cents (e.g. 1999 = $19.99)
1403
+ */
1404
+ discountAmount?: number;
1405
+ /**
1406
+ * Amount in cents (e.g. 1999 = $19.99)
1407
+ */
1408
+ total?: number;
1409
+ imageUrl?: string | null;
1410
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1411
+ /**
1412
+ * Arbitrary key-value metadata
1413
+ */
1414
+ metadata?: Record<string, any>;
1415
+ }>;
1132
1416
  /**
1133
1417
  * Payment settlement performed by the cancel: voids of open authorizations (always) and refunds of captured payments (opt-in). Failures never undo the cancel.
1134
1418
  */
@@ -1138,10 +1422,6 @@ export declare class OrdersService {
1138
1422
  status?: 'succeeded' | 'failed';
1139
1423
  error?: string;
1140
1424
  }>;
1141
- onHold?: boolean;
1142
- holdReason?: string | null;
1143
- heldAt?: string | null;
1144
- heldBy?: string | null;
1145
1425
  };
1146
1426
  meta?: {
1147
1427
  requestId?: string;
@@ -1209,6 +1489,10 @@ export declare class OrdersService {
1209
1489
  compReason?: string | null;
1210
1490
  compedAt?: string | null;
1211
1491
  compedBy?: string | null;
1492
+ onHold?: boolean;
1493
+ holdReason?: string | null;
1494
+ heldAt?: string | null;
1495
+ heldBy?: string | null;
1212
1496
  /**
1213
1497
  * Arbitrary key-value metadata
1214
1498
  */
@@ -1252,6 +1536,7 @@ export declare class OrdersService {
1252
1536
  email?: string;
1253
1537
  } | null;
1254
1538
  customerId?: string | null;
1539
+ subscriptionId?: string | null;
1255
1540
  customer?: {
1256
1541
  id?: string;
1257
1542
  email?: string;
@@ -1264,10 +1549,40 @@ export declare class OrdersService {
1264
1549
  closedAt?: string | null;
1265
1550
  createdAt?: string;
1266
1551
  updatedAt?: string;
1267
- onHold?: boolean;
1268
- holdReason?: string | null;
1269
- heldAt?: string | null;
1270
- heldBy?: string | null;
1552
+ lineItems?: Array<{
1553
+ id?: string;
1554
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
1555
+ referenceId?: string | null;
1556
+ name?: string;
1557
+ description?: string | null;
1558
+ /**
1559
+ * Amount in cents (e.g. 1999 = $19.99)
1560
+ */
1561
+ unitPrice?: number;
1562
+ quantity?: number;
1563
+ /**
1564
+ * Amount in cents (e.g. 1999 = $19.99)
1565
+ */
1566
+ subtotal?: number;
1567
+ /**
1568
+ * Amount in cents (e.g. 1999 = $19.99)
1569
+ */
1570
+ taxAmount?: number;
1571
+ /**
1572
+ * Amount in cents (e.g. 1999 = $19.99)
1573
+ */
1574
+ discountAmount?: number;
1575
+ /**
1576
+ * Amount in cents (e.g. 1999 = $19.99)
1577
+ */
1578
+ total?: number;
1579
+ imageUrl?: string | null;
1580
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1581
+ /**
1582
+ * Arbitrary key-value metadata
1583
+ */
1584
+ metadata?: Record<string, any>;
1585
+ }>;
1271
1586
  };
1272
1587
  meta?: {
1273
1588
  requestId?: string;
@@ -1334,6 +1649,10 @@ export declare class OrdersService {
1334
1649
  compReason?: string | null;
1335
1650
  compedAt?: string | null;
1336
1651
  compedBy?: string | null;
1652
+ onHold?: boolean;
1653
+ holdReason?: string | null;
1654
+ heldAt?: string | null;
1655
+ heldBy?: string | null;
1337
1656
  /**
1338
1657
  * Arbitrary key-value metadata
1339
1658
  */
@@ -1377,6 +1696,7 @@ export declare class OrdersService {
1377
1696
  email?: string;
1378
1697
  } | null;
1379
1698
  customerId?: string | null;
1699
+ subscriptionId?: string | null;
1380
1700
  customer?: {
1381
1701
  id?: string;
1382
1702
  email?: string;
@@ -1389,6 +1709,40 @@ export declare class OrdersService {
1389
1709
  closedAt?: string | null;
1390
1710
  createdAt?: string;
1391
1711
  updatedAt?: string;
1712
+ lineItems?: Array<{
1713
+ id?: string;
1714
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
1715
+ referenceId?: string | null;
1716
+ name?: string;
1717
+ description?: string | null;
1718
+ /**
1719
+ * Amount in cents (e.g. 1999 = $19.99)
1720
+ */
1721
+ unitPrice?: number;
1722
+ quantity?: number;
1723
+ /**
1724
+ * Amount in cents (e.g. 1999 = $19.99)
1725
+ */
1726
+ subtotal?: number;
1727
+ /**
1728
+ * Amount in cents (e.g. 1999 = $19.99)
1729
+ */
1730
+ taxAmount?: number;
1731
+ /**
1732
+ * Amount in cents (e.g. 1999 = $19.99)
1733
+ */
1734
+ discountAmount?: number;
1735
+ /**
1736
+ * Amount in cents (e.g. 1999 = $19.99)
1737
+ */
1738
+ total?: number;
1739
+ imageUrl?: string | null;
1740
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1741
+ /**
1742
+ * Arbitrary key-value metadata
1743
+ */
1744
+ metadata?: Record<string, any>;
1745
+ }>;
1392
1746
  /**
1393
1747
  * Payment settlement performed by the comp: voids of anything still claiming the waived balance — open authorizations, and unpaid Net-N invoices, whose buyers are also emailed. Captured money is never touched. Failures never undo the comp.
1394
1748
  */
@@ -1398,10 +1752,6 @@ export declare class OrdersService {
1398
1752
  status?: 'succeeded' | 'failed';
1399
1753
  error?: string;
1400
1754
  }>;
1401
- onHold?: boolean;
1402
- holdReason?: string | null;
1403
- heldAt?: string | null;
1404
- heldBy?: string | null;
1405
1755
  };
1406
1756
  meta?: {
1407
1757
  requestId?: string;
@@ -1465,6 +1815,10 @@ export declare class OrdersService {
1465
1815
  compReason?: string | null;
1466
1816
  compedAt?: string | null;
1467
1817
  compedBy?: string | null;
1818
+ onHold?: boolean;
1819
+ holdReason?: string | null;
1820
+ heldAt?: string | null;
1821
+ heldBy?: string | null;
1468
1822
  /**
1469
1823
  * Arbitrary key-value metadata
1470
1824
  */
@@ -1508,6 +1862,7 @@ export declare class OrdersService {
1508
1862
  email?: string;
1509
1863
  } | null;
1510
1864
  customerId?: string | null;
1865
+ subscriptionId?: string | null;
1511
1866
  customer?: {
1512
1867
  id?: string;
1513
1868
  email?: string;
@@ -1520,10 +1875,40 @@ export declare class OrdersService {
1520
1875
  closedAt?: string | null;
1521
1876
  createdAt?: string;
1522
1877
  updatedAt?: string;
1523
- onHold?: boolean;
1524
- holdReason?: string | null;
1525
- heldAt?: string | null;
1526
- heldBy?: string | null;
1878
+ lineItems?: Array<{
1879
+ id?: string;
1880
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
1881
+ referenceId?: string | null;
1882
+ name?: string;
1883
+ description?: string | null;
1884
+ /**
1885
+ * Amount in cents (e.g. 1999 = $19.99)
1886
+ */
1887
+ unitPrice?: number;
1888
+ quantity?: number;
1889
+ /**
1890
+ * Amount in cents (e.g. 1999 = $19.99)
1891
+ */
1892
+ subtotal?: number;
1893
+ /**
1894
+ * Amount in cents (e.g. 1999 = $19.99)
1895
+ */
1896
+ taxAmount?: number;
1897
+ /**
1898
+ * Amount in cents (e.g. 1999 = $19.99)
1899
+ */
1900
+ discountAmount?: number;
1901
+ /**
1902
+ * Amount in cents (e.g. 1999 = $19.99)
1903
+ */
1904
+ total?: number;
1905
+ imageUrl?: string | null;
1906
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1907
+ /**
1908
+ * Arbitrary key-value metadata
1909
+ */
1910
+ metadata?: Record<string, any>;
1911
+ }>;
1527
1912
  };
1528
1913
  meta?: {
1529
1914
  requestId?: string;
@@ -1534,71 +1919,17 @@ export declare class OrdersService {
1534
1919
  };
1535
1920
  }>;
1536
1921
  /**
1537
- * Append-only record of every status change on this order, oldest first.
1922
+ * Freeze an order operationally. A hold is a flag, not a stage: `status`, `paymentStatus` and `displayStatus` are unchanged, and nothing about money or delivery moves. Holdable while the order is still live (`pending`, `processing`, `partially_fulfilled`, `fulfilled`); a draft, cancelled or closed order answers 422 `order_not_holdable`. Re-holding with the same reason is a no-op and does not restart `heldAt`; a new reason overwrites it. `heldBy` comes from the caller's credentials and cannot be supplied.
1538
1923
  * @param id
1924
+ * @param requestBody
1539
1925
  * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1540
1926
  * @returns any Default Response
1541
1927
  * @throws ApiError
1542
1928
  */
1543
- static getApiV1OrdersStatusHistory(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
1544
- data?: Array<{
1545
- id?: string;
1546
- fromStatus?: string | null;
1547
- toStatus?: string;
1548
- actorType?: 'user' | 'system' | 'integration';
1549
- actorId?: string | null;
1550
- reason?: string | null;
1551
- source?: 'manual' | 'state_machine' | 'fulfillment' | 'payment' | 'migration';
1552
- createdAt?: string;
1553
- }>;
1554
- meta?: {
1555
- requestId?: string;
1556
- pagination?: {
1557
- cursor?: string | null;
1558
- hasMore?: boolean;
1559
- };
1560
- };
1561
- }>;
1562
- /**
1563
- * Everything that happened to this order, newest first: status changes, payment attempts (including declines, which write no status-history row), and fulfillment events. One row shape for every source.
1564
- * @param id
1565
- * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1566
- * @param limit
1567
- * @param cursor
1568
- * @returns any Default Response
1569
- * @throws ApiError
1570
- */
1571
- static getApiV1OrdersTimeline(id: string, xThrottleEnvironmentId?: string, limit?: number, cursor?: string): CancelablePromise<{
1572
- data?: Array<{
1573
- id: string;
1574
- at: string;
1575
- kind: 'status' | 'payment' | 'fulfillment' | 'hold';
1576
- title: string;
1577
- detail?: string;
1578
- amount?: number;
1579
- currency?: string;
1580
- source: 'manual' | 'state_machine' | 'fulfillment' | 'payment' | 'migration' | 'provider';
1581
- actorType?: 'user' | 'system' | 'integration' | 'api_key';
1582
- actorName?: string;
1583
- reason?: string;
1584
- }>;
1585
- meta?: {
1586
- requestId?: string;
1587
- pagination?: {
1588
- cursor?: string | null;
1589
- hasMore?: boolean;
1590
- };
1591
- };
1592
- }>;
1593
- /**
1594
- * Close a fulfilled order (archive it from active views)
1595
- * @param id
1596
- * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1597
- * @returns any Default Response
1598
- * @throws ApiError
1599
- */
1600
- static postApiV1OrdersClose(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
1601
- data?: {
1929
+ static postApiV1OrdersHold(id: string, requestBody: {
1930
+ reason: string;
1931
+ }, xThrottleEnvironmentId?: string): CancelablePromise<{
1932
+ data?: {
1602
1933
  id?: string;
1603
1934
  workspaceId?: string;
1604
1935
  discountId?: string | null;
@@ -1644,6 +1975,10 @@ export declare class OrdersService {
1644
1975
  compReason?: string | null;
1645
1976
  compedAt?: string | null;
1646
1977
  compedBy?: string | null;
1978
+ onHold?: boolean;
1979
+ holdReason?: string | null;
1980
+ heldAt?: string | null;
1981
+ heldBy?: string | null;
1647
1982
  /**
1648
1983
  * Arbitrary key-value metadata
1649
1984
  */
@@ -1687,6 +2022,7 @@ export declare class OrdersService {
1687
2022
  email?: string;
1688
2023
  } | null;
1689
2024
  customerId?: string | null;
2025
+ subscriptionId?: string | null;
1690
2026
  customer?: {
1691
2027
  id?: string;
1692
2028
  email?: string;
@@ -1699,69 +2035,40 @@ export declare class OrdersService {
1699
2035
  closedAt?: string | null;
1700
2036
  createdAt?: string;
1701
2037
  updatedAt?: string;
1702
- onHold?: boolean;
1703
- holdReason?: string | null;
1704
- heldAt?: string | null;
1705
- heldBy?: string | null;
1706
- };
1707
- meta?: {
1708
- requestId?: string;
1709
- pagination?: {
1710
- cursor?: string | null;
1711
- hasMore?: boolean;
1712
- };
1713
- };
1714
- }>;
1715
- /**
1716
- * Refund the captured payment on an order
1717
- * @param id
1718
- * @param requestBody
1719
- * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1720
- * @returns any Default Response
1721
- * @throws ApiError
1722
- */
1723
- static postApiV1OrdersRefund(id: string, requestBody: {
1724
- /**
1725
- * Partial refund amount (defaults to full amount)
1726
- */
1727
- amount?: number;
1728
- reason?: string;
1729
- }, xThrottleEnvironmentId?: string): CancelablePromise<{
1730
- data?: {
1731
- id?: string;
1732
- orderId?: string;
1733
- processor?: string;
1734
- processorTransactionId?: string | null;
1735
- processorResponse?: any | null;
1736
- /**
1737
- * Amount in cents (e.g. 1999 = $19.99)
1738
- */
1739
- amount?: number;
1740
- /**
1741
- * Amount actually captured. May be less than `amount` on a partial capture; null until captured.
1742
- */
1743
- capturedAmount?: number | null;
1744
- currency?: string;
1745
- status?: 'pending' | 'authorized' | 'processing' | 'captured' | 'failed' | 'voided' | 'expired' | 'refunded' | 'partially_refunded';
1746
- errorCode?: string | null;
1747
- /**
1748
- * Why the payment failed. For a manually-marked failure this is the reason the merchant gave.
1749
- */
1750
- errorMessage?: string | null;
1751
- method?: 'card' | 'bank_transfer' | 'wallet' | 'cash' | 'cheque' | 'external' | 'manual' | 'net30';
1752
- netN?: number;
1753
- netNSource?: 'customer_override' | 'cart_override' | 'global_default';
1754
- authorizedAt?: string | null;
1755
- capturedAt?: string | null;
1756
- voidedAt?: string | null;
1757
- disputed?: boolean;
1758
- disputeReason?: string | null;
1759
- disputeOpenedAt?: string | null;
1760
- /**
1761
- * Arbitrary key-value metadata
1762
- */
1763
- metadata?: Record<string, any>;
1764
- createdAt?: string;
2038
+ lineItems?: Array<{
2039
+ id?: string;
2040
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
2041
+ referenceId?: string | null;
2042
+ name?: string;
2043
+ description?: string | null;
2044
+ /**
2045
+ * Amount in cents (e.g. 1999 = $19.99)
2046
+ */
2047
+ unitPrice?: number;
2048
+ quantity?: number;
2049
+ /**
2050
+ * Amount in cents (e.g. 1999 = $19.99)
2051
+ */
2052
+ subtotal?: number;
2053
+ /**
2054
+ * Amount in cents (e.g. 1999 = $19.99)
2055
+ */
2056
+ taxAmount?: number;
2057
+ /**
2058
+ * Amount in cents (e.g. 1999 = $19.99)
2059
+ */
2060
+ discountAmount?: number;
2061
+ /**
2062
+ * Amount in cents (e.g. 1999 = $19.99)
2063
+ */
2064
+ total?: number;
2065
+ imageUrl?: string | null;
2066
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
2067
+ /**
2068
+ * Arbitrary key-value metadata
2069
+ */
2070
+ metadata?: Record<string, any>;
2071
+ }>;
1765
2072
  };
1766
2073
  meta?: {
1767
2074
  requestId?: string;
@@ -1772,47 +2079,13 @@ export declare class OrdersService {
1772
2079
  };
1773
2080
  }>;
1774
2081
  /**
1775
- * Add, update, or remove line items on an order. On a captured order the total delta is charged (increase) or refunded (decrease) automatically.
1776
- * @param id
1777
- * @param requestBody
1778
- * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1779
- * @returns any Default Response
1780
- * @throws ApiError
1781
- */
1782
- static patchApiV1OrdersLineItems(id: string, requestBody: {
1783
- add?: Array<{
1784
- referenceId?: string;
1785
- name: string;
1786
- unitPrice: number;
1787
- quantity: number;
1788
- type?: string;
1789
- /**
1790
- * What this item needs before it counts as delivered. Omit to resolve from `type` and `metadata`. `digital` and `access_grant` are delivered automatically on payment capture; `none` means there is nothing to deliver.
1791
- */
1792
- deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
1793
- /**
1794
- * Arbitrary key-value metadata
1795
- */
1796
- metadata?: Record<string, any>;
1797
- }>;
1798
- update?: Array<{
1799
- lineItemId: string;
1800
- quantity?: number;
1801
- unitPrice?: number;
1802
- }>;
1803
- remove?: Array<string>;
1804
- }, xThrottleEnvironmentId?: string): CancelablePromise<any>;
1805
- /**
1806
- * Freeze an order operationally. A hold is a flag, not a stage: `status`, `paymentStatus` and `displayStatus` are unchanged, and nothing about money or delivery moves. Holdable while the order is still live (`pending`, `processing`, `partially_fulfilled`, `fulfilled`); a draft, cancelled or closed order answers 422 `order_not_holdable`. Re-holding with the same reason is a no-op and does not restart `heldAt`; a new reason overwrites it. `heldBy` comes from the caller's credentials and cannot be supplied.
2082
+ * Lift a hold. All four hold columns are cleared together. An order that is not held answers 422 `order_not_on_hold`.
1807
2083
  * @param id
1808
- * @param requestBody
1809
2084
  * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1810
2085
  * @returns any Default Response
1811
2086
  * @throws ApiError
1812
2087
  */
1813
- static postApiV1OrdersHold(id: string, requestBody: {
1814
- reason: string;
1815
- }, xThrottleEnvironmentId?: string): CancelablePromise<{
2088
+ static postApiV1OrdersHoldRelease(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
1816
2089
  data?: {
1817
2090
  id?: string;
1818
2091
  workspaceId?: string;
@@ -1906,6 +2179,7 @@ export declare class OrdersService {
1906
2179
  email?: string;
1907
2180
  } | null;
1908
2181
  customerId?: string | null;
2182
+ subscriptionId?: string | null;
1909
2183
  customer?: {
1910
2184
  id?: string;
1911
2185
  email?: string;
@@ -1918,6 +2192,40 @@ export declare class OrdersService {
1918
2192
  closedAt?: string | null;
1919
2193
  createdAt?: string;
1920
2194
  updatedAt?: string;
2195
+ lineItems?: Array<{
2196
+ id?: string;
2197
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
2198
+ referenceId?: string | null;
2199
+ name?: string;
2200
+ description?: string | null;
2201
+ /**
2202
+ * Amount in cents (e.g. 1999 = $19.99)
2203
+ */
2204
+ unitPrice?: number;
2205
+ quantity?: number;
2206
+ /**
2207
+ * Amount in cents (e.g. 1999 = $19.99)
2208
+ */
2209
+ subtotal?: number;
2210
+ /**
2211
+ * Amount in cents (e.g. 1999 = $19.99)
2212
+ */
2213
+ taxAmount?: number;
2214
+ /**
2215
+ * Amount in cents (e.g. 1999 = $19.99)
2216
+ */
2217
+ discountAmount?: number;
2218
+ /**
2219
+ * Amount in cents (e.g. 1999 = $19.99)
2220
+ */
2221
+ total?: number;
2222
+ imageUrl?: string | null;
2223
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
2224
+ /**
2225
+ * Arbitrary key-value metadata
2226
+ */
2227
+ metadata?: Record<string, any>;
2228
+ }>;
1921
2229
  };
1922
2230
  meta?: {
1923
2231
  requestId?: string;
@@ -1928,13 +2236,70 @@ export declare class OrdersService {
1928
2236
  };
1929
2237
  }>;
1930
2238
  /**
1931
- * Lift a hold. All four hold columns are cleared together. An order that is not held answers 422 `order_not_on_hold`.
2239
+ * Append-only record of every status change on this order, oldest first.
1932
2240
  * @param id
1933
2241
  * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
1934
2242
  * @returns any Default Response
1935
2243
  * @throws ApiError
1936
2244
  */
1937
- static postApiV1OrdersHoldRelease(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
2245
+ static getApiV1OrdersStatusHistory(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
2246
+ data?: Array<{
2247
+ id?: string;
2248
+ fromStatus?: string | null;
2249
+ toStatus?: string;
2250
+ actorType?: 'user' | 'system' | 'integration';
2251
+ actorId?: string | null;
2252
+ reason?: string | null;
2253
+ source?: 'manual' | 'state_machine' | 'fulfillment' | 'payment' | 'migration';
2254
+ createdAt?: string;
2255
+ }>;
2256
+ meta?: {
2257
+ requestId?: string;
2258
+ pagination?: {
2259
+ cursor?: string | null;
2260
+ hasMore?: boolean;
2261
+ };
2262
+ };
2263
+ }>;
2264
+ /**
2265
+ * Everything that happened to this order, newest first: status changes, payment attempts (including declines, which write no status-history row), and fulfillment events. One row shape for every source.
2266
+ * @param id
2267
+ * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
2268
+ * @param limit
2269
+ * @param cursor
2270
+ * @returns any Default Response
2271
+ * @throws ApiError
2272
+ */
2273
+ static getApiV1OrdersTimeline(id: string, xThrottleEnvironmentId?: string, limit?: number, cursor?: string): CancelablePromise<{
2274
+ data?: Array<{
2275
+ id: string;
2276
+ at: string;
2277
+ kind: 'status' | 'payment' | 'fulfillment' | 'hold';
2278
+ title: string;
2279
+ detail?: string;
2280
+ amount?: number;
2281
+ currency?: string;
2282
+ source: 'manual' | 'state_machine' | 'fulfillment' | 'payment' | 'migration' | 'provider';
2283
+ actorType?: 'user' | 'system' | 'integration' | 'api_key';
2284
+ actorName?: string;
2285
+ reason?: string;
2286
+ }>;
2287
+ meta?: {
2288
+ requestId?: string;
2289
+ pagination?: {
2290
+ cursor?: string | null;
2291
+ hasMore?: boolean;
2292
+ };
2293
+ };
2294
+ }>;
2295
+ /**
2296
+ * Close a fulfilled order (archive it from active views)
2297
+ * @param id
2298
+ * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
2299
+ * @returns any Default Response
2300
+ * @throws ApiError
2301
+ */
2302
+ static postApiV1OrdersClose(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
1938
2303
  data?: {
1939
2304
  id?: string;
1940
2305
  workspaceId?: string;
@@ -2028,6 +2393,7 @@ export declare class OrdersService {
2028
2393
  email?: string;
2029
2394
  } | null;
2030
2395
  customerId?: string | null;
2396
+ subscriptionId?: string | null;
2031
2397
  customer?: {
2032
2398
  id?: string;
2033
2399
  email?: string;
@@ -2040,6 +2406,40 @@ export declare class OrdersService {
2040
2406
  closedAt?: string | null;
2041
2407
  createdAt?: string;
2042
2408
  updatedAt?: string;
2409
+ lineItems?: Array<{
2410
+ id?: string;
2411
+ type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
2412
+ referenceId?: string | null;
2413
+ name?: string;
2414
+ description?: string | null;
2415
+ /**
2416
+ * Amount in cents (e.g. 1999 = $19.99)
2417
+ */
2418
+ unitPrice?: number;
2419
+ quantity?: number;
2420
+ /**
2421
+ * Amount in cents (e.g. 1999 = $19.99)
2422
+ */
2423
+ subtotal?: number;
2424
+ /**
2425
+ * Amount in cents (e.g. 1999 = $19.99)
2426
+ */
2427
+ taxAmount?: number;
2428
+ /**
2429
+ * Amount in cents (e.g. 1999 = $19.99)
2430
+ */
2431
+ discountAmount?: number;
2432
+ /**
2433
+ * Amount in cents (e.g. 1999 = $19.99)
2434
+ */
2435
+ total?: number;
2436
+ imageUrl?: string | null;
2437
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
2438
+ /**
2439
+ * Arbitrary key-value metadata
2440
+ */
2441
+ metadata?: Record<string, any>;
2442
+ }>;
2043
2443
  };
2044
2444
  meta?: {
2045
2445
  requestId?: string;
@@ -2049,5 +2449,95 @@ export declare class OrdersService {
2049
2449
  };
2050
2450
  };
2051
2451
  }>;
2452
+ /**
2453
+ * Refund the captured payment on an order
2454
+ * @param id
2455
+ * @param requestBody
2456
+ * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
2457
+ * @returns any Default Response
2458
+ * @throws ApiError
2459
+ */
2460
+ static postApiV1OrdersRefund(id: string, requestBody: {
2461
+ /**
2462
+ * Partial refund amount (defaults to full amount)
2463
+ */
2464
+ amount?: number;
2465
+ reason?: string;
2466
+ }, xThrottleEnvironmentId?: string): CancelablePromise<{
2467
+ data?: {
2468
+ id?: string;
2469
+ orderId?: string;
2470
+ processor?: string;
2471
+ processorTransactionId?: string | null;
2472
+ processorResponse?: any | null;
2473
+ /**
2474
+ * Amount in cents (e.g. 1999 = $19.99)
2475
+ */
2476
+ amount?: number;
2477
+ /**
2478
+ * Amount actually captured. May be less than `amount` on a partial capture; null until captured.
2479
+ */
2480
+ capturedAmount?: number | null;
2481
+ currency?: string;
2482
+ status?: 'pending' | 'authorized' | 'processing' | 'captured' | 'failed' | 'voided' | 'expired' | 'refunded' | 'partially_refunded';
2483
+ errorCode?: string | null;
2484
+ /**
2485
+ * Why the payment failed. For a manually-marked failure this is the reason the merchant gave.
2486
+ */
2487
+ errorMessage?: string | null;
2488
+ method?: 'card' | 'bank_transfer' | 'wallet' | 'cash' | 'cheque' | 'external' | 'manual' | 'net30';
2489
+ netN?: number;
2490
+ netNSource?: 'customer_override' | 'cart_override' | 'global_default';
2491
+ authorizedAt?: string | null;
2492
+ capturedAt?: string | null;
2493
+ voidedAt?: string | null;
2494
+ disputed?: boolean;
2495
+ disputeReason?: string | null;
2496
+ disputeOpenedAt?: string | null;
2497
+ /**
2498
+ * Arbitrary key-value metadata
2499
+ */
2500
+ metadata?: Record<string, any>;
2501
+ createdAt?: string;
2502
+ };
2503
+ meta?: {
2504
+ requestId?: string;
2505
+ pagination?: {
2506
+ cursor?: string | null;
2507
+ hasMore?: boolean;
2508
+ };
2509
+ };
2510
+ }>;
2511
+ /**
2512
+ * Add, update, or remove line items on an order. On a captured order the total delta is charged (increase) or refunded (decrease) automatically.
2513
+ * @param id
2514
+ * @param requestBody
2515
+ * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
2516
+ * @returns any Default Response
2517
+ * @throws ApiError
2518
+ */
2519
+ static patchApiV1OrdersLineItems(id: string, requestBody: {
2520
+ add?: Array<{
2521
+ referenceId?: string;
2522
+ name: string;
2523
+ unitPrice: number;
2524
+ quantity: number;
2525
+ type?: string;
2526
+ /**
2527
+ * What this item needs before it counts as delivered. Omit to resolve from `type` and `metadata`. `digital` and `access_grant` are delivered automatically on payment capture; `none` means there is nothing to deliver.
2528
+ */
2529
+ deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
2530
+ /**
2531
+ * Arbitrary key-value metadata
2532
+ */
2533
+ metadata?: Record<string, any>;
2534
+ }>;
2535
+ update?: Array<{
2536
+ lineItemId: string;
2537
+ quantity?: number;
2538
+ unitPrice?: number;
2539
+ }>;
2540
+ remove?: Array<string>;
2541
+ }, xThrottleEnvironmentId?: string): CancelablePromise<any>;
2052
2542
  }
2053
2543
  //# sourceMappingURL=OrdersService.d.ts.map