@checkoutpage/sdk 0.1.2

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.
@@ -0,0 +1,3077 @@
1
+ interface CheckoutPageClientOptions {
2
+ apiKey: string;
3
+ baseUrl?: string;
4
+ }
5
+ interface RequestOptions {
6
+ method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
7
+ path: string;
8
+ body?: unknown;
9
+ query?: Record<string, string | number | boolean | undefined>;
10
+ }
11
+ declare class CheckoutPageClient {
12
+ private readonly apiKey;
13
+ private readonly baseUrl;
14
+ constructor(options: CheckoutPageClientOptions);
15
+ request<T>(options: RequestOptions): Promise<T>;
16
+ private buildUrl;
17
+ private handleResponse;
18
+ private extractErrorMessage;
19
+ }
20
+
21
+ interface operations {
22
+ "events/tickets/validate-qrcode": {
23
+ parameters: {
24
+ query?: never;
25
+ header?: never;
26
+ path: {
27
+ qrCode: string;
28
+ };
29
+ cookie?: never;
30
+ };
31
+ requestBody?: {
32
+ content: {
33
+ "application/json": {
34
+ metadata?: {
35
+ key: string;
36
+ value: string | null;
37
+ }[];
38
+ };
39
+ };
40
+ };
41
+ responses: {
42
+ /** @description QR code validation successful */
43
+ 200: {
44
+ headers: {
45
+ [name: string]: unknown;
46
+ };
47
+ content: {
48
+ "application/json": {
49
+ success: boolean;
50
+ ticket: {
51
+ id: string;
52
+ status: string;
53
+ customerName: string;
54
+ customerEmail: string;
55
+ ticketShortId: string;
56
+ /** @enum {string} */
57
+ checkInStatus?: "CHECKEDIN" | "UNCHECKEDIN";
58
+ };
59
+ metadata?: {
60
+ key: string;
61
+ value: string;
62
+ /** Format: date */
63
+ addedAt: string;
64
+ }[];
65
+ message?: string;
66
+ };
67
+ };
68
+ };
69
+ /** @description Bad request - Invalid QR code format */
70
+ 400: {
71
+ headers: {
72
+ [name: string]: unknown;
73
+ };
74
+ content?: never;
75
+ };
76
+ /** @description Unauthorized - Missing or invalid API key */
77
+ 401: {
78
+ headers: {
79
+ [name: string]: unknown;
80
+ };
81
+ content?: never;
82
+ };
83
+ /** @description Forbidden - Insufficient permissions or validation error */
84
+ 403: {
85
+ headers: {
86
+ [name: string]: unknown;
87
+ };
88
+ content?: never;
89
+ };
90
+ /** @description Not found - Ticket not found or not accessible */
91
+ 404: {
92
+ headers: {
93
+ [name: string]: unknown;
94
+ };
95
+ content?: never;
96
+ };
97
+ /** @description Unprocessable entity - Ticket status is $STATUS, expected PAID */
98
+ 422: {
99
+ headers: {
100
+ [name: string]: unknown;
101
+ };
102
+ content?: never;
103
+ };
104
+ /** @description Rate Limit Exceeded - Please try again later. */
105
+ 429: {
106
+ headers: {
107
+ [name: string]: unknown;
108
+ };
109
+ content?: never;
110
+ };
111
+ };
112
+ };
113
+ "events/bookings/list": {
114
+ parameters: {
115
+ query?: {
116
+ search?: string;
117
+ status?: string;
118
+ pageId?: string;
119
+ limit?: string;
120
+ skip?: string;
121
+ };
122
+ header?: never;
123
+ path?: never;
124
+ cookie?: never;
125
+ };
126
+ requestBody?: never;
127
+ responses: {
128
+ /** @description Bookings retrieved successfully */
129
+ 200: {
130
+ headers: {
131
+ [name: string]: unknown;
132
+ };
133
+ content: {
134
+ "application/json": {
135
+ has_more: boolean;
136
+ total?: number;
137
+ data: {
138
+ id: string;
139
+ orderId?: string;
140
+ orderStatus?: string;
141
+ stripePaymentId?: string;
142
+ customerEmail?: string;
143
+ customerId?: string;
144
+ sellerId?: string;
145
+ pageId?: string;
146
+ currency?: string;
147
+ /** @description The total amount intended to be collected. */
148
+ amount: number;
149
+ /** @description The amount of money paid toward the total. */
150
+ amountPaid?: number;
151
+ /** @description The outstanding amount of money to be paid. */
152
+ amountDue?: number;
153
+ amountUsd?: number;
154
+ amountExcludingTax?: number;
155
+ taxAmount?: number;
156
+ taxBreakdown: {
157
+ taxType?: string;
158
+ taxabilityReason?: string;
159
+ taxableAmount?: number;
160
+ taxAmount?: number;
161
+ taxRateDetails?: {
162
+ country?: string;
163
+ percentageDecimal?: number;
164
+ state?: string;
165
+ taxType?: string;
166
+ };
167
+ }[];
168
+ stripeTaxCalculationId?: string;
169
+ stripeTaxTransactionId?: string;
170
+ dynamicPrice?: number;
171
+ feeAmount?: number;
172
+ fee?: number;
173
+ fees?: {
174
+ name?: string;
175
+ amount?: number;
176
+ percentage?: number;
177
+ }[];
178
+ billing?: {
179
+ name?: string;
180
+ companyName?: string;
181
+ email?: string;
182
+ billingEmail?: string;
183
+ phone?: string;
184
+ address?: {
185
+ line1?: string;
186
+ line2?: string;
187
+ city?: string;
188
+ state?: string;
189
+ postalCode?: string;
190
+ country?: string;
191
+ };
192
+ };
193
+ shipping?: {
194
+ name?: string;
195
+ phone?: string;
196
+ address?: {
197
+ line1?: string;
198
+ line2?: string;
199
+ city?: string;
200
+ state?: string;
201
+ postalCode?: string;
202
+ country?: string;
203
+ };
204
+ };
205
+ fields?: {
206
+ fieldId?: string;
207
+ label?: string;
208
+ value?: string;
209
+ /** @enum {string} */
210
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
211
+ /** @enum {string} */
212
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
213
+ meta?: string;
214
+ reference?: string;
215
+ }[];
216
+ coupon?: {
217
+ id?: string;
218
+ label?: string;
219
+ code?: string;
220
+ amountOff?: number;
221
+ percentOff?: number;
222
+ discount?: number;
223
+ };
224
+ discount?: {
225
+ minQuantity?: number;
226
+ maxQuantity?: number;
227
+ percentOff?: number;
228
+ amountOff?: number;
229
+ amount?: number;
230
+ };
231
+ livemode?: boolean;
232
+ /** @enum {string} */
233
+ status: "created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired";
234
+ paymentError?: string;
235
+ /** @enum {string} */
236
+ statusReason?: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error";
237
+ paymentMethod?: {
238
+ /** @enum {string} */
239
+ gateway?: "stripe" | "paypal" | "manual";
240
+ method?: string;
241
+ wallet?: string;
242
+ /** @enum {string} */
243
+ mode?: "default" | "express";
244
+ brand?: string;
245
+ last4?: string;
246
+ country?: string;
247
+ exp_month?: number;
248
+ exp_year?: number;
249
+ funding?: string;
250
+ };
251
+ paymentOption?: {
252
+ /** @enum {string} */
253
+ type?: "manual" | "partial" | "full";
254
+ name?: string;
255
+ description?: string;
256
+ instructions?: string;
257
+ partialAmount?: number;
258
+ /** @enum {string} */
259
+ manualType?: "invoice" | "cash_on_delivery";
260
+ };
261
+ locale?: string;
262
+ sessionId?: string;
263
+ clientIp?: string;
264
+ userAgent?: string;
265
+ screenWidth?: number;
266
+ visitId?: string;
267
+ queryParameters?: {
268
+ [key: string]: string;
269
+ };
270
+ stripePaymentIntentId?: string;
271
+ stripePaymentIntentClientSecret?: string;
272
+ upsell?: boolean;
273
+ upsellPageId?: string;
274
+ upsellChargeId?: string;
275
+ upsellSubscriptionId?: string;
276
+ invoiceId?: string;
277
+ transactionIds?: string[];
278
+ /** @description The date this was canceled. */
279
+ canceledAt?: string;
280
+ /** @description The userId that canceled this. If this is a booking, tickets were canceled in addition. */
281
+ canceledBy?: string;
282
+ /** @description The reason for the cancellation */
283
+ reason?: string;
284
+ isAbandoned?: boolean;
285
+ /** Format: date-time */
286
+ recoveredAt?: string;
287
+ /** @enum {string} */
288
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
289
+ /** Format: date-time */
290
+ abandonedCartEmailSentAt?: string;
291
+ /** Format: date-time */
292
+ createdAt: string;
293
+ /** Format: date-time */
294
+ updatedAt: string;
295
+ productId?: string;
296
+ productPrice?: number;
297
+ payWhatYouWantPrice?: number;
298
+ discountedFromPrice?: number;
299
+ setupFee?: number;
300
+ quantity?: number;
301
+ sku?: string;
302
+ variants?: {
303
+ name?: string;
304
+ variantId?: string;
305
+ reference?: string;
306
+ /** @enum {string} */
307
+ selectionType?: "single" | "multiple" | "quantity";
308
+ sku?: string;
309
+ selectedOptions?: {
310
+ optionId?: string;
311
+ optionName?: string;
312
+ sku?: string;
313
+ quantity?: number;
314
+ additionalChargeAmount?: number;
315
+ originalAdditionalChargeAmount?: number;
316
+ discount?: {
317
+ minQuantity?: number;
318
+ maxQuantity?: number;
319
+ percentOff?: number;
320
+ amountOff?: number;
321
+ amount?: number;
322
+ };
323
+ }[];
324
+ additionalChargeAmount?: number;
325
+ originalAdditionalChargeAmount?: number;
326
+ selectedOptionName?: string;
327
+ selectedOptionId?: string;
328
+ selectedOptionQuantity?: number;
329
+ selectedOptionDiscount?: {
330
+ minQuantity?: number;
331
+ maxQuantity?: number;
332
+ percentOff?: number;
333
+ amountOff?: number;
334
+ amount?: number;
335
+ };
336
+ }[];
337
+ licenseKeyId?: string;
338
+ }[];
339
+ };
340
+ };
341
+ };
342
+ /** @description Bad request - Invalid request parameters */
343
+ 400: {
344
+ headers: {
345
+ [name: string]: unknown;
346
+ };
347
+ content?: never;
348
+ };
349
+ /** @description Unauthorized - Missing or invalid API key */
350
+ 401: {
351
+ headers: {
352
+ [name: string]: unknown;
353
+ };
354
+ content?: never;
355
+ };
356
+ /** @description Forbidden - Insufficient permissions or validation error */
357
+ 403: {
358
+ headers: {
359
+ [name: string]: unknown;
360
+ };
361
+ content?: never;
362
+ };
363
+ /** @description Rate Limit Exceeded - Please try again later. */
364
+ 429: {
365
+ headers: {
366
+ [name: string]: unknown;
367
+ };
368
+ content?: never;
369
+ };
370
+ /** @description Internal server error */
371
+ 500: {
372
+ headers: {
373
+ [name: string]: unknown;
374
+ };
375
+ content?: never;
376
+ };
377
+ };
378
+ };
379
+ "health/check": {
380
+ parameters: {
381
+ query?: never;
382
+ header?: never;
383
+ path?: never;
384
+ cookie?: never;
385
+ };
386
+ requestBody?: never;
387
+ responses: {
388
+ /** @description API key health information retrieved successfully */
389
+ 200: {
390
+ headers: {
391
+ [name: string]: unknown;
392
+ };
393
+ content: {
394
+ "application/json": {
395
+ /** @enum {string} */
396
+ status: "operational";
397
+ apiKey: {
398
+ id: string;
399
+ name: string;
400
+ permissions: string[];
401
+ scopes: string[];
402
+ isDeleted: boolean;
403
+ usageCount: number;
404
+ lastUsedAt: string | null;
405
+ createdAt: string;
406
+ expiresAt: string | null;
407
+ keyPreview: string;
408
+ };
409
+ rateLimit: {
410
+ requests: number;
411
+ window: number;
412
+ } | null;
413
+ healthScore: number;
414
+ warnings: string[];
415
+ };
416
+ };
417
+ };
418
+ /** @description Bad request - Invalid request parameters */
419
+ 400: {
420
+ headers: {
421
+ [name: string]: unknown;
422
+ };
423
+ content?: never;
424
+ };
425
+ /** @description Unauthorized - Missing or invalid API key */
426
+ 401: {
427
+ headers: {
428
+ [name: string]: unknown;
429
+ };
430
+ content?: never;
431
+ };
432
+ /** @description Forbidden - Insufficient permissions or validation error */
433
+ 403: {
434
+ headers: {
435
+ [name: string]: unknown;
436
+ };
437
+ content?: never;
438
+ };
439
+ /** @description API key not found */
440
+ 404: {
441
+ headers: {
442
+ [name: string]: unknown;
443
+ };
444
+ content?: never;
445
+ };
446
+ /** @description Rate Limit Exceeded - Please try again later. */
447
+ 429: {
448
+ headers: {
449
+ [name: string]: unknown;
450
+ };
451
+ content?: never;
452
+ };
453
+ /** @description Internal server error */
454
+ 500: {
455
+ headers: {
456
+ [name: string]: unknown;
457
+ };
458
+ content?: never;
459
+ };
460
+ };
461
+ };
462
+ "customers/list": {
463
+ parameters: {
464
+ query?: {
465
+ search?: string;
466
+ limit?: string;
467
+ skip?: string;
468
+ };
469
+ header?: never;
470
+ path?: never;
471
+ cookie?: never;
472
+ };
473
+ requestBody?: never;
474
+ responses: {
475
+ /** @description Customers retrieved successfully */
476
+ 200: {
477
+ headers: {
478
+ [name: string]: unknown;
479
+ };
480
+ content: {
481
+ "application/json": {
482
+ has_more: boolean;
483
+ total?: number;
484
+ data: {
485
+ id: string;
486
+ name?: string;
487
+ companyName?: string;
488
+ email: string;
489
+ phone?: string;
490
+ billingEmail?: string;
491
+ address?: {
492
+ line1?: string;
493
+ line2?: string;
494
+ city?: string;
495
+ state?: string;
496
+ postalCode?: string;
497
+ country?: string;
498
+ };
499
+ shipping?: {
500
+ name?: string;
501
+ phone?: string;
502
+ address?: {
503
+ line1?: string;
504
+ line2?: string;
505
+ city?: string;
506
+ state?: string;
507
+ postalCode?: string;
508
+ country?: string;
509
+ };
510
+ };
511
+ taxId?: string;
512
+ taxIdType?: string;
513
+ seller: string;
514
+ stripeCustomerId?: string;
515
+ /** Format: date-time */
516
+ createdAt: string;
517
+ /** Format: date-time */
518
+ updatedAt: string;
519
+ }[];
520
+ };
521
+ };
522
+ };
523
+ /** @description Bad request - Invalid request parameters */
524
+ 400: {
525
+ headers: {
526
+ [name: string]: unknown;
527
+ };
528
+ content?: never;
529
+ };
530
+ /** @description Unauthorized - Missing or invalid API key */
531
+ 401: {
532
+ headers: {
533
+ [name: string]: unknown;
534
+ };
535
+ content?: never;
536
+ };
537
+ /** @description Forbidden - Insufficient permissions or validation error */
538
+ 403: {
539
+ headers: {
540
+ [name: string]: unknown;
541
+ };
542
+ content?: never;
543
+ };
544
+ /** @description Rate Limit Exceeded - Please try again later. */
545
+ 429: {
546
+ headers: {
547
+ [name: string]: unknown;
548
+ };
549
+ content?: never;
550
+ };
551
+ /** @description Internal server error */
552
+ 500: {
553
+ headers: {
554
+ [name: string]: unknown;
555
+ };
556
+ content?: never;
557
+ };
558
+ };
559
+ };
560
+ "customers/get": {
561
+ parameters: {
562
+ query?: never;
563
+ header?: never;
564
+ path: {
565
+ customerId: string;
566
+ };
567
+ cookie?: never;
568
+ };
569
+ requestBody?: never;
570
+ responses: {
571
+ /** @description Customer retrieved successfully */
572
+ 200: {
573
+ headers: {
574
+ [name: string]: unknown;
575
+ };
576
+ content: {
577
+ "application/json": {
578
+ id: string;
579
+ name?: string;
580
+ companyName?: string;
581
+ email: string;
582
+ phone?: string;
583
+ billingEmail?: string;
584
+ address?: {
585
+ line1?: string;
586
+ line2?: string;
587
+ city?: string;
588
+ state?: string;
589
+ postalCode?: string;
590
+ country?: string;
591
+ };
592
+ shipping?: {
593
+ name?: string;
594
+ phone?: string;
595
+ address?: {
596
+ line1?: string;
597
+ line2?: string;
598
+ city?: string;
599
+ state?: string;
600
+ postalCode?: string;
601
+ country?: string;
602
+ };
603
+ };
604
+ taxId?: string;
605
+ taxIdType?: string;
606
+ seller: string;
607
+ stripeCustomerId?: string;
608
+ /** Format: date-time */
609
+ createdAt: string;
610
+ /** Format: date-time */
611
+ updatedAt: string;
612
+ };
613
+ };
614
+ };
615
+ /** @description Bad request - Invalid request parameters */
616
+ 400: {
617
+ headers: {
618
+ [name: string]: unknown;
619
+ };
620
+ content?: never;
621
+ };
622
+ /** @description Unauthorized - Missing or invalid API key */
623
+ 401: {
624
+ headers: {
625
+ [name: string]: unknown;
626
+ };
627
+ content?: never;
628
+ };
629
+ /** @description Forbidden - Insufficient permissions or validation error */
630
+ 403: {
631
+ headers: {
632
+ [name: string]: unknown;
633
+ };
634
+ content?: never;
635
+ };
636
+ /** @description Customer not found or not accessible */
637
+ 404: {
638
+ headers: {
639
+ [name: string]: unknown;
640
+ };
641
+ content?: never;
642
+ };
643
+ /** @description Rate Limit Exceeded - Please try again later. */
644
+ 429: {
645
+ headers: {
646
+ [name: string]: unknown;
647
+ };
648
+ content?: never;
649
+ };
650
+ /** @description Internal server error */
651
+ 500: {
652
+ headers: {
653
+ [name: string]: unknown;
654
+ };
655
+ content?: never;
656
+ };
657
+ };
658
+ };
659
+ "coupons/list": {
660
+ parameters: {
661
+ query?: {
662
+ search?: string;
663
+ limit?: string;
664
+ skip?: string;
665
+ };
666
+ header?: never;
667
+ path?: never;
668
+ cookie?: never;
669
+ };
670
+ requestBody?: never;
671
+ responses: {
672
+ /** @description Coupons retrieved successfully */
673
+ 200: {
674
+ headers: {
675
+ [name: string]: unknown;
676
+ };
677
+ content: {
678
+ "application/json": {
679
+ has_more: boolean;
680
+ total?: number;
681
+ data: {
682
+ id: string;
683
+ label: string;
684
+ code: string;
685
+ amountOff?: number | null;
686
+ percentOff?: number | null;
687
+ appliesToSetupFee?: boolean;
688
+ /** @enum {string} */
689
+ duration: "once" | "repeating" | "forever";
690
+ durationInMonths?: number;
691
+ /** Format: date-time */
692
+ redeemBy?: string;
693
+ maxRedemptions?: number;
694
+ timesRedeemed: number;
695
+ currency?: string;
696
+ deleted: boolean;
697
+ sellerId: string;
698
+ pageIds?: string[];
699
+ stripeId?: string;
700
+ /** Format: date-time */
701
+ createdAt: string;
702
+ /** Format: date-time */
703
+ updatedAt: string;
704
+ }[];
705
+ };
706
+ };
707
+ };
708
+ /** @description Bad request - Invalid request parameters */
709
+ 400: {
710
+ headers: {
711
+ [name: string]: unknown;
712
+ };
713
+ content?: never;
714
+ };
715
+ /** @description Unauthorized - Missing or invalid API key */
716
+ 401: {
717
+ headers: {
718
+ [name: string]: unknown;
719
+ };
720
+ content?: never;
721
+ };
722
+ /** @description Forbidden - Insufficient permissions or validation error */
723
+ 403: {
724
+ headers: {
725
+ [name: string]: unknown;
726
+ };
727
+ content?: never;
728
+ };
729
+ /** @description Rate Limit Exceeded - Please try again later. */
730
+ 429: {
731
+ headers: {
732
+ [name: string]: unknown;
733
+ };
734
+ content?: never;
735
+ };
736
+ /** @description Internal server error */
737
+ 500: {
738
+ headers: {
739
+ [name: string]: unknown;
740
+ };
741
+ content?: never;
742
+ };
743
+ };
744
+ };
745
+ "coupons/create": {
746
+ parameters: {
747
+ query?: never;
748
+ header?: never;
749
+ path?: never;
750
+ cookie?: never;
751
+ };
752
+ requestBody?: {
753
+ content: {
754
+ "application/json": {
755
+ /**
756
+ * @description Internal name for the coupon.
757
+ * @example Free shipping within US
758
+ */
759
+ label: string;
760
+ /**
761
+ * @description The coupon code a customer enters.
762
+ * @example 10Off
763
+ */
764
+ code: string;
765
+ /**
766
+ * @description A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).
767
+ * @example 100
768
+ */
769
+ amountOff?: number;
770
+ /**
771
+ * @description Three-letter ISO code for the currency of the amountOff parameter (required if amountOff is passed).
772
+ * @example usd
773
+ * @enum {string}
774
+ */
775
+ currency?: "aed" | "aud" | "brl" | "cad" | "chf" | "clp" | "czk" | "dkk" | "eur" | "gbp" | "hkd" | "inr" | "jpy" | "mxn" | "myr" | "nok" | "nzd" | "ron" | "php" | "pln" | "sek" | "sgd" | "usd" | "zar";
776
+ /** @enum {string} */
777
+ duration: "once" | "repeating" | "forever";
778
+ /**
779
+ * @description A positive integer representing the number of months the coupon applies for (required if duration === repeating)
780
+ * @example 3
781
+ */
782
+ durationInMonths?: number;
783
+ /** @description A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed). */
784
+ percentOff?: number;
785
+ /**
786
+ * @description Apply discount to setup fee
787
+ * @example true
788
+ */
789
+ appliesToSetupFee?: boolean;
790
+ /**
791
+ * @description A list of pageIds that this coupon can be used within.
792
+ * @example [
793
+ * {
794
+ * "description": "67ee075004de439ab0b675b6"
795
+ * },
796
+ * {
797
+ * "description": "67fcbdac6a91c25ef2d3534a"
798
+ * }
799
+ * ]
800
+ * @example 67ee075004de439ab0b675b6
801
+ * @example 67fcbdac6a91c25ef2d3534a
802
+ */
803
+ pageIds?: string[];
804
+ /**
805
+ * @description The total amount of times this coupon can be used. Doesn't limit a single customer from redeeming multiple times.
806
+ * @example 5
807
+ */
808
+ maxRedemptions?: number;
809
+ /**
810
+ * Format: date-time
811
+ * @description The ISO datetime that this coupon must be used before.
812
+ * @example 2025-10-04T07:36:45.122Z
813
+ */
814
+ redeemBy?: string;
815
+ };
816
+ };
817
+ };
818
+ responses: {
819
+ /** @description Coupon created successfully */
820
+ 201: {
821
+ headers: {
822
+ [name: string]: unknown;
823
+ };
824
+ content: {
825
+ "application/json": {
826
+ id: string;
827
+ label: string;
828
+ code: string;
829
+ amountOff?: number | null;
830
+ percentOff?: number | null;
831
+ appliesToSetupFee?: boolean;
832
+ /** @enum {string} */
833
+ duration: "once" | "repeating" | "forever";
834
+ durationInMonths?: number;
835
+ /** Format: date-time */
836
+ redeemBy?: string;
837
+ maxRedemptions?: number;
838
+ timesRedeemed: number;
839
+ currency?: string;
840
+ deleted: boolean;
841
+ sellerId: string;
842
+ pageIds?: string[];
843
+ stripeId?: string;
844
+ /** Format: date-time */
845
+ createdAt: string;
846
+ /** Format: date-time */
847
+ updatedAt: string;
848
+ };
849
+ };
850
+ };
851
+ /** @description Bad request - Invalid request parameters */
852
+ 400: {
853
+ headers: {
854
+ [name: string]: unknown;
855
+ };
856
+ content?: never;
857
+ };
858
+ /** @description Unauthorized - Missing or invalid API key */
859
+ 401: {
860
+ headers: {
861
+ [name: string]: unknown;
862
+ };
863
+ content?: never;
864
+ };
865
+ /** @description Forbidden - Insufficient permissions or validation error */
866
+ 403: {
867
+ headers: {
868
+ [name: string]: unknown;
869
+ };
870
+ content?: never;
871
+ };
872
+ /** @description Conflict - Coupon code already exists */
873
+ 409: {
874
+ headers: {
875
+ [name: string]: unknown;
876
+ };
877
+ content?: never;
878
+ };
879
+ /** @description Rate Limit Exceeded - Please try again later. */
880
+ 429: {
881
+ headers: {
882
+ [name: string]: unknown;
883
+ };
884
+ content?: never;
885
+ };
886
+ /** @description Internal server error */
887
+ 500: {
888
+ headers: {
889
+ [name: string]: unknown;
890
+ };
891
+ content?: never;
892
+ };
893
+ };
894
+ };
895
+ "subscriptions/list": {
896
+ parameters: {
897
+ query?: {
898
+ search?: string;
899
+ pageId?: string;
900
+ status?: string;
901
+ limit?: string;
902
+ skip?: string;
903
+ };
904
+ header?: never;
905
+ path?: never;
906
+ cookie?: never;
907
+ };
908
+ requestBody?: never;
909
+ responses: {
910
+ /** @description Subscriptions retrieved successfully */
911
+ 200: {
912
+ headers: {
913
+ [name: string]: unknown;
914
+ };
915
+ content: {
916
+ "application/json": {
917
+ has_more: boolean;
918
+ total?: number;
919
+ data: {
920
+ id: string;
921
+ orderId?: string;
922
+ subscriptionId?: string;
923
+ customerEmail?: string;
924
+ currency?: string;
925
+ amount: number;
926
+ amountUsd?: number;
927
+ interval?: string;
928
+ intervalCount?: number;
929
+ planIterations?: number;
930
+ fees?: {
931
+ name?: string;
932
+ amount?: number;
933
+ percentage?: number;
934
+ stripeProductId?: string;
935
+ }[];
936
+ setupFee?: number;
937
+ setupFeeDiscountAmount?: number;
938
+ setupFeeFees?: {
939
+ name?: string;
940
+ amount?: number;
941
+ percentage?: number;
942
+ stripeInvoiceItemId?: string;
943
+ }[];
944
+ setupFeeTotal?: number;
945
+ setupFeeUsd?: number;
946
+ setupFeeInvoiceItemId?: string;
947
+ setupFeeInvoiceItemPaid?: boolean;
948
+ quantity?: number;
949
+ productPrice?: number;
950
+ dynamicPrice?: number;
951
+ discountedFromPrice?: number;
952
+ feePercentage?: number;
953
+ sku?: string;
954
+ billing?: {
955
+ name?: string;
956
+ companyName?: string;
957
+ email?: string;
958
+ billingEmail?: string;
959
+ phone?: string;
960
+ address?: {
961
+ line1?: string;
962
+ line2?: string;
963
+ city?: string;
964
+ state?: string;
965
+ postalCode?: string;
966
+ country?: string;
967
+ };
968
+ };
969
+ shipping?: {
970
+ name?: string;
971
+ phone?: string;
972
+ address?: {
973
+ line1?: string;
974
+ line2?: string;
975
+ city?: string;
976
+ state?: string;
977
+ postalCode?: string;
978
+ country?: string;
979
+ };
980
+ };
981
+ fields?: {
982
+ fieldId?: string;
983
+ label?: string;
984
+ value?: string;
985
+ /** @enum {string} */
986
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
987
+ /** @enum {string} */
988
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
989
+ reference?: string;
990
+ }[];
991
+ variants?: {
992
+ name?: string;
993
+ variantId?: string;
994
+ reference?: string;
995
+ /** @enum {string} */
996
+ selectionType?: "single" | "multiple" | "quantity";
997
+ selectedOptions?: {
998
+ optionId?: string;
999
+ /** @enum {string} */
1000
+ optionType?: "one_time" | "recurring";
1001
+ optionName?: string;
1002
+ sku?: string;
1003
+ quantity?: number;
1004
+ additionalChargeAmount?: number;
1005
+ discountAmount?: number;
1006
+ fees?: {
1007
+ name?: string;
1008
+ amount?: number;
1009
+ percentage?: number;
1010
+ stripeInvoiceItemId?: string;
1011
+ }[];
1012
+ additionalChargeAmountTotal?: number;
1013
+ additionalChargeAmountUsd?: number;
1014
+ optionStripePriceId?: string;
1015
+ optionStripeProductId?: string;
1016
+ optionInvoiceItemId?: string;
1017
+ optionInvoiceItemPaid?: boolean;
1018
+ }[];
1019
+ selectedOptionName?: string;
1020
+ additionalChargeAmount?: number;
1021
+ discountAmount?: number;
1022
+ fees?: {
1023
+ name?: string;
1024
+ amount?: number;
1025
+ percentage?: number;
1026
+ stripeInvoiceItemId?: string;
1027
+ }[];
1028
+ additionalChargeAmountTotal?: number;
1029
+ additionalChargeAmountUsd?: number;
1030
+ sku?: string;
1031
+ /** @enum {string} */
1032
+ selectedOptionType?: "one_time" | "recurring";
1033
+ selectedOptionId?: string;
1034
+ selectedOptionQuantity?: number;
1035
+ selectedOptionStripePriceId?: string;
1036
+ selectedOptionStripeProductId?: string;
1037
+ selectedOptionInvoiceItemId?: string;
1038
+ selectedOptionInvoiceItemPaid?: boolean;
1039
+ }[];
1040
+ couponId?: string;
1041
+ licenseKeyId?: string;
1042
+ livemode?: boolean;
1043
+ /** @enum {string} */
1044
+ status?: "draft" | "draft_expired" | "incomplete" | "incomplete_expired" | "trialing" | "scheduled" | "active" | "past_due" | "canceled" | "unpaid" | "failed" | "completed";
1045
+ /** @enum {string} */
1046
+ paymentStatus?: "draft" | "deleted" | "open" | "paid" | "uncollectible" | "void" | "requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded";
1047
+ paymentError?: string;
1048
+ paymentMethod?: {
1049
+ /** @enum {string} */
1050
+ gateway?: "stripe" | "paypal" | "manual";
1051
+ method?: string;
1052
+ wallet?: string;
1053
+ /** @enum {string} */
1054
+ mode?: "default" | "express";
1055
+ brand?: string;
1056
+ last4?: string;
1057
+ country?: string;
1058
+ exp_month?: number;
1059
+ exp_year?: number;
1060
+ funding?: string;
1061
+ };
1062
+ locale?: string;
1063
+ sessionId?: string;
1064
+ clientIp?: string;
1065
+ userAgent?: string;
1066
+ screenWidth?: number;
1067
+ visitId?: string;
1068
+ queryParameters?: {
1069
+ key: string;
1070
+ value: string;
1071
+ }[];
1072
+ stripePaymentIntentId?: string;
1073
+ stripePaymentIntentClientSecret?: string;
1074
+ stripeSetupIntentId?: string;
1075
+ /** Format: date-time */
1076
+ startDate?: string;
1077
+ /** Format: date-time */
1078
+ trialEnd?: string;
1079
+ /** Format: date-time */
1080
+ trialStart?: string;
1081
+ /** Format: date-time */
1082
+ cancelAt?: string;
1083
+ cancelAtPeriodEnd?: boolean;
1084
+ /** Format: date-time */
1085
+ currentPeriodStart?: string;
1086
+ /** Format: date-time */
1087
+ currentPeriodEnd?: string;
1088
+ upsell?: boolean;
1089
+ upsellPageId?: string;
1090
+ upsellChargeId?: string;
1091
+ upsellSubscriptionId?: string;
1092
+ stripeSubscriptionId?: string;
1093
+ stripeCustomerId?: string;
1094
+ sellerId?: string;
1095
+ customerId?: string;
1096
+ pageId?: string;
1097
+ productId?: string;
1098
+ /** Format: date-time */
1099
+ canceledAt?: string;
1100
+ canceledBy?: string;
1101
+ reason?: string;
1102
+ isAbandoned?: boolean;
1103
+ /** Format: date-time */
1104
+ recoveredAt?: string;
1105
+ /** @enum {string} */
1106
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
1107
+ /** Format: date-time */
1108
+ abandonedCartEmailSentAt?: string;
1109
+ /** Format: date-time */
1110
+ createdAt: string;
1111
+ /** Format: date-time */
1112
+ updatedAt: string;
1113
+ }[];
1114
+ };
1115
+ };
1116
+ };
1117
+ /** @description Bad request - Invalid request parameters */
1118
+ 400: {
1119
+ headers: {
1120
+ [name: string]: unknown;
1121
+ };
1122
+ content?: never;
1123
+ };
1124
+ /** @description Unauthorized - Missing or invalid API key */
1125
+ 401: {
1126
+ headers: {
1127
+ [name: string]: unknown;
1128
+ };
1129
+ content?: never;
1130
+ };
1131
+ /** @description Forbidden - Insufficient permissions or validation error */
1132
+ 403: {
1133
+ headers: {
1134
+ [name: string]: unknown;
1135
+ };
1136
+ content?: never;
1137
+ };
1138
+ /** @description Rate Limit Exceeded - Please try again later. */
1139
+ 429: {
1140
+ headers: {
1141
+ [name: string]: unknown;
1142
+ };
1143
+ content?: never;
1144
+ };
1145
+ /** @description Internal server error */
1146
+ 500: {
1147
+ headers: {
1148
+ [name: string]: unknown;
1149
+ };
1150
+ content?: never;
1151
+ };
1152
+ };
1153
+ };
1154
+ "payments/list": {
1155
+ parameters: {
1156
+ query?: {
1157
+ search?: string;
1158
+ status?: string;
1159
+ pageId?: string;
1160
+ limit?: string;
1161
+ skip?: string;
1162
+ };
1163
+ header?: never;
1164
+ path?: never;
1165
+ cookie?: never;
1166
+ };
1167
+ requestBody?: never;
1168
+ responses: {
1169
+ /** @description Payments retrieved successfully */
1170
+ 200: {
1171
+ headers: {
1172
+ [name: string]: unknown;
1173
+ };
1174
+ content: {
1175
+ "application/json": {
1176
+ has_more: boolean;
1177
+ total?: number;
1178
+ data: {
1179
+ id: string;
1180
+ orderId?: string;
1181
+ orderStatus?: string;
1182
+ stripePaymentId?: string;
1183
+ customerEmail?: string;
1184
+ customerId?: string;
1185
+ sellerId?: string;
1186
+ pageId?: string;
1187
+ currency?: string;
1188
+ /** @description The total amount intended to be collected. */
1189
+ amount: number;
1190
+ /** @description The amount of money paid toward the total. */
1191
+ amountPaid?: number;
1192
+ /** @description The outstanding amount of money to be paid. */
1193
+ amountDue?: number;
1194
+ amountUsd?: number;
1195
+ amountExcludingTax?: number;
1196
+ taxAmount?: number;
1197
+ taxBreakdown: {
1198
+ taxType?: string;
1199
+ taxabilityReason?: string;
1200
+ taxableAmount?: number;
1201
+ taxAmount?: number;
1202
+ taxRateDetails?: {
1203
+ country?: string;
1204
+ percentageDecimal?: number;
1205
+ state?: string;
1206
+ taxType?: string;
1207
+ };
1208
+ }[];
1209
+ stripeTaxCalculationId?: string;
1210
+ stripeTaxTransactionId?: string;
1211
+ dynamicPrice?: number;
1212
+ feeAmount?: number;
1213
+ fee?: number;
1214
+ fees?: {
1215
+ name?: string;
1216
+ amount?: number;
1217
+ percentage?: number;
1218
+ }[];
1219
+ billing?: {
1220
+ name?: string;
1221
+ companyName?: string;
1222
+ email?: string;
1223
+ billingEmail?: string;
1224
+ phone?: string;
1225
+ address?: {
1226
+ line1?: string;
1227
+ line2?: string;
1228
+ city?: string;
1229
+ state?: string;
1230
+ postalCode?: string;
1231
+ country?: string;
1232
+ };
1233
+ };
1234
+ shipping?: {
1235
+ name?: string;
1236
+ phone?: string;
1237
+ address?: {
1238
+ line1?: string;
1239
+ line2?: string;
1240
+ city?: string;
1241
+ state?: string;
1242
+ postalCode?: string;
1243
+ country?: string;
1244
+ };
1245
+ };
1246
+ fields?: {
1247
+ fieldId?: string;
1248
+ label?: string;
1249
+ value?: string;
1250
+ /** @enum {string} */
1251
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
1252
+ /** @enum {string} */
1253
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
1254
+ meta?: string;
1255
+ reference?: string;
1256
+ }[];
1257
+ coupon?: {
1258
+ id?: string;
1259
+ label?: string;
1260
+ code?: string;
1261
+ amountOff?: number;
1262
+ percentOff?: number;
1263
+ discount?: number;
1264
+ };
1265
+ discount?: {
1266
+ minQuantity?: number;
1267
+ maxQuantity?: number;
1268
+ percentOff?: number;
1269
+ amountOff?: number;
1270
+ amount?: number;
1271
+ };
1272
+ livemode?: boolean;
1273
+ /** @enum {string} */
1274
+ status: "created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired";
1275
+ paymentError?: string;
1276
+ /** @enum {string} */
1277
+ statusReason?: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error";
1278
+ paymentMethod?: {
1279
+ /** @enum {string} */
1280
+ gateway?: "stripe" | "paypal" | "manual";
1281
+ method?: string;
1282
+ wallet?: string;
1283
+ /** @enum {string} */
1284
+ mode?: "default" | "express";
1285
+ brand?: string;
1286
+ last4?: string;
1287
+ country?: string;
1288
+ exp_month?: number;
1289
+ exp_year?: number;
1290
+ funding?: string;
1291
+ };
1292
+ paymentOption?: {
1293
+ /** @enum {string} */
1294
+ type?: "manual" | "partial" | "full";
1295
+ name?: string;
1296
+ description?: string;
1297
+ instructions?: string;
1298
+ partialAmount?: number;
1299
+ /** @enum {string} */
1300
+ manualType?: "invoice" | "cash_on_delivery";
1301
+ };
1302
+ locale?: string;
1303
+ sessionId?: string;
1304
+ clientIp?: string;
1305
+ userAgent?: string;
1306
+ screenWidth?: number;
1307
+ visitId?: string;
1308
+ queryParameters?: {
1309
+ [key: string]: string;
1310
+ };
1311
+ stripePaymentIntentId?: string;
1312
+ stripePaymentIntentClientSecret?: string;
1313
+ upsell?: boolean;
1314
+ upsellPageId?: string;
1315
+ upsellChargeId?: string;
1316
+ upsellSubscriptionId?: string;
1317
+ invoiceId?: string;
1318
+ transactionIds?: string[];
1319
+ /** @description The date this was canceled. */
1320
+ canceledAt?: string;
1321
+ /** @description The userId that canceled this. If this is a booking, tickets were canceled in addition. */
1322
+ canceledBy?: string;
1323
+ /** @description The reason for the cancellation */
1324
+ reason?: string;
1325
+ isAbandoned?: boolean;
1326
+ /** Format: date-time */
1327
+ recoveredAt?: string;
1328
+ /** @enum {string} */
1329
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
1330
+ /** Format: date-time */
1331
+ abandonedCartEmailSentAt?: string;
1332
+ /** Format: date-time */
1333
+ createdAt: string;
1334
+ /** Format: date-time */
1335
+ updatedAt: string;
1336
+ productId?: string;
1337
+ productPrice?: number;
1338
+ payWhatYouWantPrice?: number;
1339
+ discountedFromPrice?: number;
1340
+ setupFee?: number;
1341
+ quantity?: number;
1342
+ sku?: string;
1343
+ variants?: {
1344
+ name?: string;
1345
+ variantId?: string;
1346
+ reference?: string;
1347
+ /** @enum {string} */
1348
+ selectionType?: "single" | "multiple" | "quantity";
1349
+ sku?: string;
1350
+ selectedOptions?: {
1351
+ optionId?: string;
1352
+ optionName?: string;
1353
+ sku?: string;
1354
+ quantity?: number;
1355
+ additionalChargeAmount?: number;
1356
+ originalAdditionalChargeAmount?: number;
1357
+ discount?: {
1358
+ minQuantity?: number;
1359
+ maxQuantity?: number;
1360
+ percentOff?: number;
1361
+ amountOff?: number;
1362
+ amount?: number;
1363
+ };
1364
+ }[];
1365
+ additionalChargeAmount?: number;
1366
+ originalAdditionalChargeAmount?: number;
1367
+ selectedOptionName?: string;
1368
+ selectedOptionId?: string;
1369
+ selectedOptionQuantity?: number;
1370
+ selectedOptionDiscount?: {
1371
+ minQuantity?: number;
1372
+ maxQuantity?: number;
1373
+ percentOff?: number;
1374
+ amountOff?: number;
1375
+ amount?: number;
1376
+ };
1377
+ }[];
1378
+ licenseKeyId?: string;
1379
+ }[];
1380
+ };
1381
+ };
1382
+ };
1383
+ /** @description Bad request - Invalid request parameters */
1384
+ 400: {
1385
+ headers: {
1386
+ [name: string]: unknown;
1387
+ };
1388
+ content?: never;
1389
+ };
1390
+ /** @description Unauthorized - Missing or invalid API key */
1391
+ 401: {
1392
+ headers: {
1393
+ [name: string]: unknown;
1394
+ };
1395
+ content?: never;
1396
+ };
1397
+ /** @description Forbidden - Insufficient permissions or validation error */
1398
+ 403: {
1399
+ headers: {
1400
+ [name: string]: unknown;
1401
+ };
1402
+ content?: never;
1403
+ };
1404
+ /** @description Rate Limit Exceeded - Please try again later. */
1405
+ 429: {
1406
+ headers: {
1407
+ [name: string]: unknown;
1408
+ };
1409
+ content?: never;
1410
+ };
1411
+ /** @description Internal server error */
1412
+ 500: {
1413
+ headers: {
1414
+ [name: string]: unknown;
1415
+ };
1416
+ content?: never;
1417
+ };
1418
+ };
1419
+ };
1420
+ "webhooks/customer.created": {
1421
+ parameters: {
1422
+ query?: never;
1423
+ header?: never;
1424
+ path?: never;
1425
+ cookie?: never;
1426
+ };
1427
+ requestBody?: {
1428
+ content: {
1429
+ "application/json": {
1430
+ seller_id: string;
1431
+ /** Format: date-time */
1432
+ timestamp: string;
1433
+ /** @description Unique identifier for idempotency */
1434
+ event_id: string;
1435
+ /** @enum {string} */
1436
+ event: "customer.created";
1437
+ data: {
1438
+ customer: {
1439
+ id: string;
1440
+ name?: string;
1441
+ companyName?: string;
1442
+ email: string;
1443
+ phone?: string;
1444
+ billingEmail?: string;
1445
+ address?: {
1446
+ line1?: string;
1447
+ line2?: string;
1448
+ city?: string;
1449
+ state?: string;
1450
+ postalCode?: string;
1451
+ country?: string;
1452
+ };
1453
+ shipping?: {
1454
+ name?: string;
1455
+ phone?: string;
1456
+ address?: {
1457
+ line1?: string;
1458
+ line2?: string;
1459
+ city?: string;
1460
+ state?: string;
1461
+ postalCode?: string;
1462
+ country?: string;
1463
+ };
1464
+ };
1465
+ taxId?: string;
1466
+ taxIdType?: string;
1467
+ seller: string;
1468
+ stripeCustomerId?: string;
1469
+ /** Format: date-time */
1470
+ createdAt: string;
1471
+ /** Format: date-time */
1472
+ updatedAt: string;
1473
+ };
1474
+ };
1475
+ };
1476
+ };
1477
+ };
1478
+ responses: {
1479
+ /** @description Return a 200 status to indicate that the data was received successfully. */
1480
+ 200: {
1481
+ headers: {
1482
+ [name: string]: unknown;
1483
+ };
1484
+ content?: never;
1485
+ };
1486
+ };
1487
+ };
1488
+ "webhooks/customer.updated": {
1489
+ parameters: {
1490
+ query?: never;
1491
+ header?: never;
1492
+ path?: never;
1493
+ cookie?: never;
1494
+ };
1495
+ requestBody?: {
1496
+ content: {
1497
+ "application/json": {
1498
+ seller_id: string;
1499
+ /** Format: date-time */
1500
+ timestamp: string;
1501
+ /** @description Unique identifier for idempotency */
1502
+ event_id: string;
1503
+ /** @enum {string} */
1504
+ event: "customer.updated";
1505
+ data: {
1506
+ customer: {
1507
+ id: string;
1508
+ name?: string;
1509
+ companyName?: string;
1510
+ email: string;
1511
+ phone?: string;
1512
+ billingEmail?: string;
1513
+ address?: {
1514
+ line1?: string;
1515
+ line2?: string;
1516
+ city?: string;
1517
+ state?: string;
1518
+ postalCode?: string;
1519
+ country?: string;
1520
+ };
1521
+ shipping?: {
1522
+ name?: string;
1523
+ phone?: string;
1524
+ address?: {
1525
+ line1?: string;
1526
+ line2?: string;
1527
+ city?: string;
1528
+ state?: string;
1529
+ postalCode?: string;
1530
+ country?: string;
1531
+ };
1532
+ };
1533
+ taxId?: string;
1534
+ taxIdType?: string;
1535
+ seller: string;
1536
+ stripeCustomerId?: string;
1537
+ /** Format: date-time */
1538
+ createdAt: string;
1539
+ /** Format: date-time */
1540
+ updatedAt: string;
1541
+ };
1542
+ };
1543
+ };
1544
+ };
1545
+ };
1546
+ responses: {
1547
+ /** @description Return a 200 status to indicate that the data was received successfully. */
1548
+ 200: {
1549
+ headers: {
1550
+ [name: string]: unknown;
1551
+ };
1552
+ content?: never;
1553
+ };
1554
+ };
1555
+ };
1556
+ "webhooks/payment.created": {
1557
+ parameters: {
1558
+ query?: never;
1559
+ header?: never;
1560
+ path?: never;
1561
+ cookie?: never;
1562
+ };
1563
+ requestBody?: {
1564
+ content: {
1565
+ "application/json": {
1566
+ seller_id: string;
1567
+ /** Format: date-time */
1568
+ timestamp: string;
1569
+ /** @description Unique identifier for idempotency */
1570
+ event_id: string;
1571
+ /** @enum {string} */
1572
+ event: "payment.created";
1573
+ data: {
1574
+ payment: {
1575
+ id: string;
1576
+ orderId?: string;
1577
+ orderStatus?: string;
1578
+ stripePaymentId?: string;
1579
+ customerEmail?: string;
1580
+ customerId?: string;
1581
+ sellerId?: string;
1582
+ pageId?: string;
1583
+ currency?: string;
1584
+ /** @description The total amount intended to be collected. */
1585
+ amount: number;
1586
+ /** @description The amount of money paid toward the total. */
1587
+ amountPaid?: number;
1588
+ /** @description The outstanding amount of money to be paid. */
1589
+ amountDue?: number;
1590
+ amountUsd?: number;
1591
+ amountExcludingTax?: number;
1592
+ taxAmount?: number;
1593
+ taxBreakdown: {
1594
+ taxType?: string;
1595
+ taxabilityReason?: string;
1596
+ taxableAmount?: number;
1597
+ taxAmount?: number;
1598
+ taxRateDetails?: {
1599
+ country?: string;
1600
+ percentageDecimal?: number;
1601
+ state?: string;
1602
+ taxType?: string;
1603
+ };
1604
+ }[];
1605
+ stripeTaxCalculationId?: string;
1606
+ stripeTaxTransactionId?: string;
1607
+ dynamicPrice?: number;
1608
+ feeAmount?: number;
1609
+ fee?: number;
1610
+ fees?: {
1611
+ name?: string;
1612
+ amount?: number;
1613
+ percentage?: number;
1614
+ }[];
1615
+ billing?: {
1616
+ name?: string;
1617
+ companyName?: string;
1618
+ email?: string;
1619
+ billingEmail?: string;
1620
+ phone?: string;
1621
+ address?: {
1622
+ line1?: string;
1623
+ line2?: string;
1624
+ city?: string;
1625
+ state?: string;
1626
+ postalCode?: string;
1627
+ country?: string;
1628
+ };
1629
+ };
1630
+ shipping?: {
1631
+ name?: string;
1632
+ phone?: string;
1633
+ address?: {
1634
+ line1?: string;
1635
+ line2?: string;
1636
+ city?: string;
1637
+ state?: string;
1638
+ postalCode?: string;
1639
+ country?: string;
1640
+ };
1641
+ };
1642
+ fields?: {
1643
+ fieldId?: string;
1644
+ label?: string;
1645
+ value?: string;
1646
+ /** @enum {string} */
1647
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
1648
+ /** @enum {string} */
1649
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
1650
+ meta?: string;
1651
+ reference?: string;
1652
+ }[];
1653
+ coupon?: {
1654
+ id?: string;
1655
+ label?: string;
1656
+ code?: string;
1657
+ amountOff?: number;
1658
+ percentOff?: number;
1659
+ discount?: number;
1660
+ };
1661
+ discount?: {
1662
+ minQuantity?: number;
1663
+ maxQuantity?: number;
1664
+ percentOff?: number;
1665
+ amountOff?: number;
1666
+ amount?: number;
1667
+ };
1668
+ livemode?: boolean;
1669
+ /** @enum {string} */
1670
+ status: "created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired";
1671
+ paymentError?: string;
1672
+ /** @enum {string} */
1673
+ statusReason?: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error";
1674
+ paymentMethod?: {
1675
+ /** @enum {string} */
1676
+ gateway?: "stripe" | "paypal" | "manual";
1677
+ method?: string;
1678
+ wallet?: string;
1679
+ /** @enum {string} */
1680
+ mode?: "default" | "express";
1681
+ brand?: string;
1682
+ last4?: string;
1683
+ country?: string;
1684
+ exp_month?: number;
1685
+ exp_year?: number;
1686
+ funding?: string;
1687
+ };
1688
+ paymentOption?: {
1689
+ /** @enum {string} */
1690
+ type?: "manual" | "partial" | "full";
1691
+ name?: string;
1692
+ description?: string;
1693
+ instructions?: string;
1694
+ partialAmount?: number;
1695
+ /** @enum {string} */
1696
+ manualType?: "invoice" | "cash_on_delivery";
1697
+ };
1698
+ locale?: string;
1699
+ sessionId?: string;
1700
+ clientIp?: string;
1701
+ userAgent?: string;
1702
+ screenWidth?: number;
1703
+ visitId?: string;
1704
+ queryParameters?: {
1705
+ [key: string]: string;
1706
+ };
1707
+ stripePaymentIntentId?: string;
1708
+ stripePaymentIntentClientSecret?: string;
1709
+ upsell?: boolean;
1710
+ upsellPageId?: string;
1711
+ upsellChargeId?: string;
1712
+ upsellSubscriptionId?: string;
1713
+ invoiceId?: string;
1714
+ transactionIds?: string[];
1715
+ /** @description The date this was canceled. */
1716
+ canceledAt?: string;
1717
+ /** @description The userId that canceled this. If this is a booking, tickets were canceled in addition. */
1718
+ canceledBy?: string;
1719
+ /** @description The reason for the cancellation */
1720
+ reason?: string;
1721
+ isAbandoned?: boolean;
1722
+ /** Format: date-time */
1723
+ recoveredAt?: string;
1724
+ /** @enum {string} */
1725
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
1726
+ /** Format: date-time */
1727
+ abandonedCartEmailSentAt?: string;
1728
+ /** Format: date-time */
1729
+ createdAt: string;
1730
+ /** Format: date-time */
1731
+ updatedAt: string;
1732
+ productId?: string;
1733
+ productPrice?: number;
1734
+ payWhatYouWantPrice?: number;
1735
+ discountedFromPrice?: number;
1736
+ setupFee?: number;
1737
+ quantity?: number;
1738
+ sku?: string;
1739
+ variants?: {
1740
+ name?: string;
1741
+ variantId?: string;
1742
+ reference?: string;
1743
+ /** @enum {string} */
1744
+ selectionType?: "single" | "multiple" | "quantity";
1745
+ sku?: string;
1746
+ selectedOptions?: {
1747
+ optionId?: string;
1748
+ optionName?: string;
1749
+ sku?: string;
1750
+ quantity?: number;
1751
+ additionalChargeAmount?: number;
1752
+ originalAdditionalChargeAmount?: number;
1753
+ discount?: {
1754
+ minQuantity?: number;
1755
+ maxQuantity?: number;
1756
+ percentOff?: number;
1757
+ amountOff?: number;
1758
+ amount?: number;
1759
+ };
1760
+ }[];
1761
+ additionalChargeAmount?: number;
1762
+ originalAdditionalChargeAmount?: number;
1763
+ selectedOptionName?: string;
1764
+ selectedOptionId?: string;
1765
+ selectedOptionQuantity?: number;
1766
+ selectedOptionDiscount?: {
1767
+ minQuantity?: number;
1768
+ maxQuantity?: number;
1769
+ percentOff?: number;
1770
+ amountOff?: number;
1771
+ amount?: number;
1772
+ };
1773
+ }[];
1774
+ licenseKeyId?: string;
1775
+ };
1776
+ };
1777
+ };
1778
+ };
1779
+ };
1780
+ responses: {
1781
+ /** @description Return a 200 status to indicate that the data was received successfully. */
1782
+ 200: {
1783
+ headers: {
1784
+ [name: string]: unknown;
1785
+ };
1786
+ content?: never;
1787
+ };
1788
+ };
1789
+ };
1790
+ "webhooks/payment.paid": {
1791
+ parameters: {
1792
+ query?: never;
1793
+ header?: never;
1794
+ path?: never;
1795
+ cookie?: never;
1796
+ };
1797
+ requestBody?: {
1798
+ content: {
1799
+ "application/json": {
1800
+ seller_id: string;
1801
+ /** Format: date-time */
1802
+ timestamp: string;
1803
+ /** @description Unique identifier for idempotency */
1804
+ event_id: string;
1805
+ /** @enum {string} */
1806
+ event: "payment.paid";
1807
+ data: {
1808
+ payment: {
1809
+ id: string;
1810
+ orderId?: string;
1811
+ orderStatus?: string;
1812
+ stripePaymentId?: string;
1813
+ customerEmail?: string;
1814
+ customerId?: string;
1815
+ sellerId?: string;
1816
+ pageId?: string;
1817
+ currency?: string;
1818
+ /** @description The total amount intended to be collected. */
1819
+ amount: number;
1820
+ /** @description The amount of money paid toward the total. */
1821
+ amountPaid?: number;
1822
+ /** @description The outstanding amount of money to be paid. */
1823
+ amountDue?: number;
1824
+ amountUsd?: number;
1825
+ amountExcludingTax?: number;
1826
+ taxAmount?: number;
1827
+ taxBreakdown: {
1828
+ taxType?: string;
1829
+ taxabilityReason?: string;
1830
+ taxableAmount?: number;
1831
+ taxAmount?: number;
1832
+ taxRateDetails?: {
1833
+ country?: string;
1834
+ percentageDecimal?: number;
1835
+ state?: string;
1836
+ taxType?: string;
1837
+ };
1838
+ }[];
1839
+ stripeTaxCalculationId?: string;
1840
+ stripeTaxTransactionId?: string;
1841
+ dynamicPrice?: number;
1842
+ feeAmount?: number;
1843
+ fee?: number;
1844
+ fees?: {
1845
+ name?: string;
1846
+ amount?: number;
1847
+ percentage?: number;
1848
+ }[];
1849
+ billing?: {
1850
+ name?: string;
1851
+ companyName?: string;
1852
+ email?: string;
1853
+ billingEmail?: string;
1854
+ phone?: string;
1855
+ address?: {
1856
+ line1?: string;
1857
+ line2?: string;
1858
+ city?: string;
1859
+ state?: string;
1860
+ postalCode?: string;
1861
+ country?: string;
1862
+ };
1863
+ };
1864
+ shipping?: {
1865
+ name?: string;
1866
+ phone?: string;
1867
+ address?: {
1868
+ line1?: string;
1869
+ line2?: string;
1870
+ city?: string;
1871
+ state?: string;
1872
+ postalCode?: string;
1873
+ country?: string;
1874
+ };
1875
+ };
1876
+ fields?: {
1877
+ fieldId?: string;
1878
+ label?: string;
1879
+ value?: string;
1880
+ /** @enum {string} */
1881
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
1882
+ /** @enum {string} */
1883
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
1884
+ meta?: string;
1885
+ reference?: string;
1886
+ }[];
1887
+ coupon?: {
1888
+ id?: string;
1889
+ label?: string;
1890
+ code?: string;
1891
+ amountOff?: number;
1892
+ percentOff?: number;
1893
+ discount?: number;
1894
+ };
1895
+ discount?: {
1896
+ minQuantity?: number;
1897
+ maxQuantity?: number;
1898
+ percentOff?: number;
1899
+ amountOff?: number;
1900
+ amount?: number;
1901
+ };
1902
+ livemode?: boolean;
1903
+ /** @enum {string} */
1904
+ status: "created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired";
1905
+ paymentError?: string;
1906
+ /** @enum {string} */
1907
+ statusReason?: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error";
1908
+ paymentMethod?: {
1909
+ /** @enum {string} */
1910
+ gateway?: "stripe" | "paypal" | "manual";
1911
+ method?: string;
1912
+ wallet?: string;
1913
+ /** @enum {string} */
1914
+ mode?: "default" | "express";
1915
+ brand?: string;
1916
+ last4?: string;
1917
+ country?: string;
1918
+ exp_month?: number;
1919
+ exp_year?: number;
1920
+ funding?: string;
1921
+ };
1922
+ paymentOption?: {
1923
+ /** @enum {string} */
1924
+ type?: "manual" | "partial" | "full";
1925
+ name?: string;
1926
+ description?: string;
1927
+ instructions?: string;
1928
+ partialAmount?: number;
1929
+ /** @enum {string} */
1930
+ manualType?: "invoice" | "cash_on_delivery";
1931
+ };
1932
+ locale?: string;
1933
+ sessionId?: string;
1934
+ clientIp?: string;
1935
+ userAgent?: string;
1936
+ screenWidth?: number;
1937
+ visitId?: string;
1938
+ queryParameters?: {
1939
+ [key: string]: string;
1940
+ };
1941
+ stripePaymentIntentId?: string;
1942
+ stripePaymentIntentClientSecret?: string;
1943
+ upsell?: boolean;
1944
+ upsellPageId?: string;
1945
+ upsellChargeId?: string;
1946
+ upsellSubscriptionId?: string;
1947
+ invoiceId?: string;
1948
+ transactionIds?: string[];
1949
+ /** @description The date this was canceled. */
1950
+ canceledAt?: string;
1951
+ /** @description The userId that canceled this. If this is a booking, tickets were canceled in addition. */
1952
+ canceledBy?: string;
1953
+ /** @description The reason for the cancellation */
1954
+ reason?: string;
1955
+ isAbandoned?: boolean;
1956
+ /** Format: date-time */
1957
+ recoveredAt?: string;
1958
+ /** @enum {string} */
1959
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
1960
+ /** Format: date-time */
1961
+ abandonedCartEmailSentAt?: string;
1962
+ /** Format: date-time */
1963
+ createdAt: string;
1964
+ /** Format: date-time */
1965
+ updatedAt: string;
1966
+ productId?: string;
1967
+ productPrice?: number;
1968
+ payWhatYouWantPrice?: number;
1969
+ discountedFromPrice?: number;
1970
+ setupFee?: number;
1971
+ quantity?: number;
1972
+ sku?: string;
1973
+ variants?: {
1974
+ name?: string;
1975
+ variantId?: string;
1976
+ reference?: string;
1977
+ /** @enum {string} */
1978
+ selectionType?: "single" | "multiple" | "quantity";
1979
+ sku?: string;
1980
+ selectedOptions?: {
1981
+ optionId?: string;
1982
+ optionName?: string;
1983
+ sku?: string;
1984
+ quantity?: number;
1985
+ additionalChargeAmount?: number;
1986
+ originalAdditionalChargeAmount?: number;
1987
+ discount?: {
1988
+ minQuantity?: number;
1989
+ maxQuantity?: number;
1990
+ percentOff?: number;
1991
+ amountOff?: number;
1992
+ amount?: number;
1993
+ };
1994
+ }[];
1995
+ additionalChargeAmount?: number;
1996
+ originalAdditionalChargeAmount?: number;
1997
+ selectedOptionName?: string;
1998
+ selectedOptionId?: string;
1999
+ selectedOptionQuantity?: number;
2000
+ selectedOptionDiscount?: {
2001
+ minQuantity?: number;
2002
+ maxQuantity?: number;
2003
+ percentOff?: number;
2004
+ amountOff?: number;
2005
+ amount?: number;
2006
+ };
2007
+ }[];
2008
+ licenseKeyId?: string;
2009
+ };
2010
+ };
2011
+ };
2012
+ };
2013
+ };
2014
+ responses: {
2015
+ /** @description Return a 200 status to indicate that the data was received successfully. */
2016
+ 200: {
2017
+ headers: {
2018
+ [name: string]: unknown;
2019
+ };
2020
+ content?: never;
2021
+ };
2022
+ };
2023
+ };
2024
+ "webhooks/booking.created": {
2025
+ parameters: {
2026
+ query?: never;
2027
+ header?: never;
2028
+ path?: never;
2029
+ cookie?: never;
2030
+ };
2031
+ requestBody?: {
2032
+ content: {
2033
+ "application/json": {
2034
+ seller_id: string;
2035
+ /** Format: date-time */
2036
+ timestamp: string;
2037
+ /** @description Unique identifier for idempotency */
2038
+ event_id: string;
2039
+ /** @enum {string} */
2040
+ event: "booking.created";
2041
+ data: {
2042
+ booking: {
2043
+ id: string;
2044
+ orderId?: string;
2045
+ orderStatus?: string;
2046
+ stripePaymentId?: string;
2047
+ customerEmail?: string;
2048
+ customerId?: string;
2049
+ sellerId?: string;
2050
+ pageId?: string;
2051
+ currency?: string;
2052
+ /** @description The total amount intended to be collected. */
2053
+ amount: number;
2054
+ /** @description The amount of money paid toward the total. */
2055
+ amountPaid?: number;
2056
+ /** @description The outstanding amount of money to be paid. */
2057
+ amountDue?: number;
2058
+ amountUsd?: number;
2059
+ amountExcludingTax?: number;
2060
+ taxAmount?: number;
2061
+ taxBreakdown: {
2062
+ taxType?: string;
2063
+ taxabilityReason?: string;
2064
+ taxableAmount?: number;
2065
+ taxAmount?: number;
2066
+ taxRateDetails?: {
2067
+ country?: string;
2068
+ percentageDecimal?: number;
2069
+ state?: string;
2070
+ taxType?: string;
2071
+ };
2072
+ }[];
2073
+ stripeTaxCalculationId?: string;
2074
+ stripeTaxTransactionId?: string;
2075
+ dynamicPrice?: number;
2076
+ feeAmount?: number;
2077
+ fee?: number;
2078
+ fees?: {
2079
+ name?: string;
2080
+ amount?: number;
2081
+ percentage?: number;
2082
+ }[];
2083
+ billing?: {
2084
+ name?: string;
2085
+ companyName?: string;
2086
+ email?: string;
2087
+ billingEmail?: string;
2088
+ phone?: string;
2089
+ address?: {
2090
+ line1?: string;
2091
+ line2?: string;
2092
+ city?: string;
2093
+ state?: string;
2094
+ postalCode?: string;
2095
+ country?: string;
2096
+ };
2097
+ };
2098
+ shipping?: {
2099
+ name?: string;
2100
+ phone?: string;
2101
+ address?: {
2102
+ line1?: string;
2103
+ line2?: string;
2104
+ city?: string;
2105
+ state?: string;
2106
+ postalCode?: string;
2107
+ country?: string;
2108
+ };
2109
+ };
2110
+ fields?: {
2111
+ fieldId?: string;
2112
+ label?: string;
2113
+ value?: string;
2114
+ /** @enum {string} */
2115
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
2116
+ /** @enum {string} */
2117
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
2118
+ meta?: string;
2119
+ reference?: string;
2120
+ }[];
2121
+ coupon?: {
2122
+ id?: string;
2123
+ label?: string;
2124
+ code?: string;
2125
+ amountOff?: number;
2126
+ percentOff?: number;
2127
+ discount?: number;
2128
+ };
2129
+ discount?: {
2130
+ minQuantity?: number;
2131
+ maxQuantity?: number;
2132
+ percentOff?: number;
2133
+ amountOff?: number;
2134
+ amount?: number;
2135
+ };
2136
+ livemode?: boolean;
2137
+ /** @enum {string} */
2138
+ status: "created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired";
2139
+ paymentError?: string;
2140
+ /** @enum {string} */
2141
+ statusReason?: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error";
2142
+ paymentMethod?: {
2143
+ /** @enum {string} */
2144
+ gateway?: "stripe" | "paypal" | "manual";
2145
+ method?: string;
2146
+ wallet?: string;
2147
+ /** @enum {string} */
2148
+ mode?: "default" | "express";
2149
+ brand?: string;
2150
+ last4?: string;
2151
+ country?: string;
2152
+ exp_month?: number;
2153
+ exp_year?: number;
2154
+ funding?: string;
2155
+ };
2156
+ paymentOption?: {
2157
+ /** @enum {string} */
2158
+ type?: "manual" | "partial" | "full";
2159
+ name?: string;
2160
+ description?: string;
2161
+ instructions?: string;
2162
+ partialAmount?: number;
2163
+ /** @enum {string} */
2164
+ manualType?: "invoice" | "cash_on_delivery";
2165
+ };
2166
+ locale?: string;
2167
+ sessionId?: string;
2168
+ clientIp?: string;
2169
+ userAgent?: string;
2170
+ screenWidth?: number;
2171
+ visitId?: string;
2172
+ queryParameters?: {
2173
+ [key: string]: string;
2174
+ };
2175
+ stripePaymentIntentId?: string;
2176
+ stripePaymentIntentClientSecret?: string;
2177
+ upsell?: boolean;
2178
+ upsellPageId?: string;
2179
+ upsellChargeId?: string;
2180
+ upsellSubscriptionId?: string;
2181
+ invoiceId?: string;
2182
+ transactionIds?: string[];
2183
+ /** @description The date this was canceled. */
2184
+ canceledAt?: string;
2185
+ /** @description The userId that canceled this. If this is a booking, tickets were canceled in addition. */
2186
+ canceledBy?: string;
2187
+ /** @description The reason for the cancellation */
2188
+ reason?: string;
2189
+ isAbandoned?: boolean;
2190
+ /** Format: date-time */
2191
+ recoveredAt?: string;
2192
+ /** @enum {string} */
2193
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
2194
+ /** Format: date-time */
2195
+ abandonedCartEmailSentAt?: string;
2196
+ /** Format: date-time */
2197
+ createdAt: string;
2198
+ /** Format: date-time */
2199
+ updatedAt: string;
2200
+ productId?: string;
2201
+ productPrice?: number;
2202
+ payWhatYouWantPrice?: number;
2203
+ discountedFromPrice?: number;
2204
+ setupFee?: number;
2205
+ quantity?: number;
2206
+ sku?: string;
2207
+ variants?: {
2208
+ name?: string;
2209
+ variantId?: string;
2210
+ reference?: string;
2211
+ /** @enum {string} */
2212
+ selectionType?: "single" | "multiple" | "quantity";
2213
+ sku?: string;
2214
+ selectedOptions?: {
2215
+ optionId?: string;
2216
+ optionName?: string;
2217
+ sku?: string;
2218
+ quantity?: number;
2219
+ additionalChargeAmount?: number;
2220
+ originalAdditionalChargeAmount?: number;
2221
+ discount?: {
2222
+ minQuantity?: number;
2223
+ maxQuantity?: number;
2224
+ percentOff?: number;
2225
+ amountOff?: number;
2226
+ amount?: number;
2227
+ };
2228
+ }[];
2229
+ additionalChargeAmount?: number;
2230
+ originalAdditionalChargeAmount?: number;
2231
+ selectedOptionName?: string;
2232
+ selectedOptionId?: string;
2233
+ selectedOptionQuantity?: number;
2234
+ selectedOptionDiscount?: {
2235
+ minQuantity?: number;
2236
+ maxQuantity?: number;
2237
+ percentOff?: number;
2238
+ amountOff?: number;
2239
+ amount?: number;
2240
+ };
2241
+ }[];
2242
+ licenseKeyId?: string;
2243
+ };
2244
+ };
2245
+ };
2246
+ };
2247
+ };
2248
+ responses: {
2249
+ /** @description Return a 200 status to indicate that the data was received successfully. */
2250
+ 200: {
2251
+ headers: {
2252
+ [name: string]: unknown;
2253
+ };
2254
+ content?: never;
2255
+ };
2256
+ };
2257
+ };
2258
+ "webhooks/booking.paid": {
2259
+ parameters: {
2260
+ query?: never;
2261
+ header?: never;
2262
+ path?: never;
2263
+ cookie?: never;
2264
+ };
2265
+ requestBody?: {
2266
+ content: {
2267
+ "application/json": {
2268
+ seller_id: string;
2269
+ /** Format: date-time */
2270
+ timestamp: string;
2271
+ /** @description Unique identifier for idempotency */
2272
+ event_id: string;
2273
+ /** @enum {string} */
2274
+ event: "booking.paid";
2275
+ data: {
2276
+ booking: {
2277
+ id: string;
2278
+ orderId?: string;
2279
+ orderStatus?: string;
2280
+ stripePaymentId?: string;
2281
+ customerEmail?: string;
2282
+ customerId?: string;
2283
+ sellerId?: string;
2284
+ pageId?: string;
2285
+ currency?: string;
2286
+ /** @description The total amount intended to be collected. */
2287
+ amount: number;
2288
+ /** @description The amount of money paid toward the total. */
2289
+ amountPaid?: number;
2290
+ /** @description The outstanding amount of money to be paid. */
2291
+ amountDue?: number;
2292
+ amountUsd?: number;
2293
+ amountExcludingTax?: number;
2294
+ taxAmount?: number;
2295
+ taxBreakdown: {
2296
+ taxType?: string;
2297
+ taxabilityReason?: string;
2298
+ taxableAmount?: number;
2299
+ taxAmount?: number;
2300
+ taxRateDetails?: {
2301
+ country?: string;
2302
+ percentageDecimal?: number;
2303
+ state?: string;
2304
+ taxType?: string;
2305
+ };
2306
+ }[];
2307
+ stripeTaxCalculationId?: string;
2308
+ stripeTaxTransactionId?: string;
2309
+ dynamicPrice?: number;
2310
+ feeAmount?: number;
2311
+ fee?: number;
2312
+ fees?: {
2313
+ name?: string;
2314
+ amount?: number;
2315
+ percentage?: number;
2316
+ }[];
2317
+ billing?: {
2318
+ name?: string;
2319
+ companyName?: string;
2320
+ email?: string;
2321
+ billingEmail?: string;
2322
+ phone?: string;
2323
+ address?: {
2324
+ line1?: string;
2325
+ line2?: string;
2326
+ city?: string;
2327
+ state?: string;
2328
+ postalCode?: string;
2329
+ country?: string;
2330
+ };
2331
+ };
2332
+ shipping?: {
2333
+ name?: string;
2334
+ phone?: string;
2335
+ address?: {
2336
+ line1?: string;
2337
+ line2?: string;
2338
+ city?: string;
2339
+ state?: string;
2340
+ postalCode?: string;
2341
+ country?: string;
2342
+ };
2343
+ };
2344
+ fields?: {
2345
+ fieldId?: string;
2346
+ label?: string;
2347
+ value?: string;
2348
+ /** @enum {string} */
2349
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
2350
+ /** @enum {string} */
2351
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
2352
+ meta?: string;
2353
+ reference?: string;
2354
+ }[];
2355
+ coupon?: {
2356
+ id?: string;
2357
+ label?: string;
2358
+ code?: string;
2359
+ amountOff?: number;
2360
+ percentOff?: number;
2361
+ discount?: number;
2362
+ };
2363
+ discount?: {
2364
+ minQuantity?: number;
2365
+ maxQuantity?: number;
2366
+ percentOff?: number;
2367
+ amountOff?: number;
2368
+ amount?: number;
2369
+ };
2370
+ livemode?: boolean;
2371
+ /** @enum {string} */
2372
+ status: "created" | "pending" | "unpaid" | "partially_paid" | "paid" | "canceled" | "failed" | "partial_refund" | "refunded" | "draft" | "draft_expired";
2373
+ paymentError?: string;
2374
+ /** @enum {string} */
2375
+ statusReason?: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error";
2376
+ paymentMethod?: {
2377
+ /** @enum {string} */
2378
+ gateway?: "stripe" | "paypal" | "manual";
2379
+ method?: string;
2380
+ wallet?: string;
2381
+ /** @enum {string} */
2382
+ mode?: "default" | "express";
2383
+ brand?: string;
2384
+ last4?: string;
2385
+ country?: string;
2386
+ exp_month?: number;
2387
+ exp_year?: number;
2388
+ funding?: string;
2389
+ };
2390
+ paymentOption?: {
2391
+ /** @enum {string} */
2392
+ type?: "manual" | "partial" | "full";
2393
+ name?: string;
2394
+ description?: string;
2395
+ instructions?: string;
2396
+ partialAmount?: number;
2397
+ /** @enum {string} */
2398
+ manualType?: "invoice" | "cash_on_delivery";
2399
+ };
2400
+ locale?: string;
2401
+ sessionId?: string;
2402
+ clientIp?: string;
2403
+ userAgent?: string;
2404
+ screenWidth?: number;
2405
+ visitId?: string;
2406
+ queryParameters?: {
2407
+ [key: string]: string;
2408
+ };
2409
+ stripePaymentIntentId?: string;
2410
+ stripePaymentIntentClientSecret?: string;
2411
+ upsell?: boolean;
2412
+ upsellPageId?: string;
2413
+ upsellChargeId?: string;
2414
+ upsellSubscriptionId?: string;
2415
+ invoiceId?: string;
2416
+ transactionIds?: string[];
2417
+ /** @description The date this was canceled. */
2418
+ canceledAt?: string;
2419
+ /** @description The userId that canceled this. If this is a booking, tickets were canceled in addition. */
2420
+ canceledBy?: string;
2421
+ /** @description The reason for the cancellation */
2422
+ reason?: string;
2423
+ isAbandoned?: boolean;
2424
+ /** Format: date-time */
2425
+ recoveredAt?: string;
2426
+ /** @enum {string} */
2427
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
2428
+ /** Format: date-time */
2429
+ abandonedCartEmailSentAt?: string;
2430
+ /** Format: date-time */
2431
+ createdAt: string;
2432
+ /** Format: date-time */
2433
+ updatedAt: string;
2434
+ productId?: string;
2435
+ productPrice?: number;
2436
+ payWhatYouWantPrice?: number;
2437
+ discountedFromPrice?: number;
2438
+ setupFee?: number;
2439
+ quantity?: number;
2440
+ sku?: string;
2441
+ variants?: {
2442
+ name?: string;
2443
+ variantId?: string;
2444
+ reference?: string;
2445
+ /** @enum {string} */
2446
+ selectionType?: "single" | "multiple" | "quantity";
2447
+ sku?: string;
2448
+ selectedOptions?: {
2449
+ optionId?: string;
2450
+ optionName?: string;
2451
+ sku?: string;
2452
+ quantity?: number;
2453
+ additionalChargeAmount?: number;
2454
+ originalAdditionalChargeAmount?: number;
2455
+ discount?: {
2456
+ minQuantity?: number;
2457
+ maxQuantity?: number;
2458
+ percentOff?: number;
2459
+ amountOff?: number;
2460
+ amount?: number;
2461
+ };
2462
+ }[];
2463
+ additionalChargeAmount?: number;
2464
+ originalAdditionalChargeAmount?: number;
2465
+ selectedOptionName?: string;
2466
+ selectedOptionId?: string;
2467
+ selectedOptionQuantity?: number;
2468
+ selectedOptionDiscount?: {
2469
+ minQuantity?: number;
2470
+ maxQuantity?: number;
2471
+ percentOff?: number;
2472
+ amountOff?: number;
2473
+ amount?: number;
2474
+ };
2475
+ }[];
2476
+ licenseKeyId?: string;
2477
+ };
2478
+ };
2479
+ };
2480
+ };
2481
+ };
2482
+ responses: {
2483
+ /** @description Return a 200 status to indicate that the data was received successfully. */
2484
+ 200: {
2485
+ headers: {
2486
+ [name: string]: unknown;
2487
+ };
2488
+ content?: never;
2489
+ };
2490
+ };
2491
+ };
2492
+ "webhooks/subscription.created": {
2493
+ parameters: {
2494
+ query?: never;
2495
+ header?: never;
2496
+ path?: never;
2497
+ cookie?: never;
2498
+ };
2499
+ requestBody?: {
2500
+ content: {
2501
+ "application/json": {
2502
+ seller_id: string;
2503
+ /** Format: date-time */
2504
+ timestamp: string;
2505
+ /** @description Unique identifier for idempotency */
2506
+ event_id: string;
2507
+ /** @enum {string} */
2508
+ event: "subscription.created";
2509
+ data: {
2510
+ subscription: {
2511
+ id: string;
2512
+ orderId?: string;
2513
+ subscriptionId?: string;
2514
+ customerEmail?: string;
2515
+ currency?: string;
2516
+ amount: number;
2517
+ amountUsd?: number;
2518
+ interval?: string;
2519
+ intervalCount?: number;
2520
+ planIterations?: number;
2521
+ fees?: {
2522
+ name?: string;
2523
+ amount?: number;
2524
+ percentage?: number;
2525
+ stripeProductId?: string;
2526
+ }[];
2527
+ setupFee?: number;
2528
+ setupFeeDiscountAmount?: number;
2529
+ setupFeeFees?: {
2530
+ name?: string;
2531
+ amount?: number;
2532
+ percentage?: number;
2533
+ stripeInvoiceItemId?: string;
2534
+ }[];
2535
+ setupFeeTotal?: number;
2536
+ setupFeeUsd?: number;
2537
+ setupFeeInvoiceItemId?: string;
2538
+ setupFeeInvoiceItemPaid?: boolean;
2539
+ quantity?: number;
2540
+ productPrice?: number;
2541
+ dynamicPrice?: number;
2542
+ discountedFromPrice?: number;
2543
+ feePercentage?: number;
2544
+ sku?: string;
2545
+ billing?: {
2546
+ name?: string;
2547
+ companyName?: string;
2548
+ email?: string;
2549
+ billingEmail?: string;
2550
+ phone?: string;
2551
+ address?: {
2552
+ line1?: string;
2553
+ line2?: string;
2554
+ city?: string;
2555
+ state?: string;
2556
+ postalCode?: string;
2557
+ country?: string;
2558
+ };
2559
+ };
2560
+ shipping?: {
2561
+ name?: string;
2562
+ phone?: string;
2563
+ address?: {
2564
+ line1?: string;
2565
+ line2?: string;
2566
+ city?: string;
2567
+ state?: string;
2568
+ postalCode?: string;
2569
+ country?: string;
2570
+ };
2571
+ };
2572
+ fields?: {
2573
+ fieldId?: string;
2574
+ label?: string;
2575
+ value?: string;
2576
+ /** @enum {string} */
2577
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
2578
+ /** @enum {string} */
2579
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
2580
+ reference?: string;
2581
+ }[];
2582
+ variants?: {
2583
+ name?: string;
2584
+ variantId?: string;
2585
+ reference?: string;
2586
+ /** @enum {string} */
2587
+ selectionType?: "single" | "multiple" | "quantity";
2588
+ selectedOptions?: {
2589
+ optionId?: string;
2590
+ /** @enum {string} */
2591
+ optionType?: "one_time" | "recurring";
2592
+ optionName?: string;
2593
+ sku?: string;
2594
+ quantity?: number;
2595
+ additionalChargeAmount?: number;
2596
+ discountAmount?: number;
2597
+ fees?: {
2598
+ name?: string;
2599
+ amount?: number;
2600
+ percentage?: number;
2601
+ stripeInvoiceItemId?: string;
2602
+ }[];
2603
+ additionalChargeAmountTotal?: number;
2604
+ additionalChargeAmountUsd?: number;
2605
+ optionStripePriceId?: string;
2606
+ optionStripeProductId?: string;
2607
+ optionInvoiceItemId?: string;
2608
+ optionInvoiceItemPaid?: boolean;
2609
+ }[];
2610
+ selectedOptionName?: string;
2611
+ additionalChargeAmount?: number;
2612
+ discountAmount?: number;
2613
+ fees?: {
2614
+ name?: string;
2615
+ amount?: number;
2616
+ percentage?: number;
2617
+ stripeInvoiceItemId?: string;
2618
+ }[];
2619
+ additionalChargeAmountTotal?: number;
2620
+ additionalChargeAmountUsd?: number;
2621
+ sku?: string;
2622
+ /** @enum {string} */
2623
+ selectedOptionType?: "one_time" | "recurring";
2624
+ selectedOptionId?: string;
2625
+ selectedOptionQuantity?: number;
2626
+ selectedOptionStripePriceId?: string;
2627
+ selectedOptionStripeProductId?: string;
2628
+ selectedOptionInvoiceItemId?: string;
2629
+ selectedOptionInvoiceItemPaid?: boolean;
2630
+ }[];
2631
+ couponId?: string;
2632
+ licenseKeyId?: string;
2633
+ livemode?: boolean;
2634
+ /** @enum {string} */
2635
+ status?: "draft" | "draft_expired" | "incomplete" | "incomplete_expired" | "trialing" | "scheduled" | "active" | "past_due" | "canceled" | "unpaid" | "failed" | "completed";
2636
+ /** @enum {string} */
2637
+ paymentStatus?: "draft" | "deleted" | "open" | "paid" | "uncollectible" | "void" | "requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded";
2638
+ paymentError?: string;
2639
+ paymentMethod?: {
2640
+ /** @enum {string} */
2641
+ gateway?: "stripe" | "paypal" | "manual";
2642
+ method?: string;
2643
+ wallet?: string;
2644
+ /** @enum {string} */
2645
+ mode?: "default" | "express";
2646
+ brand?: string;
2647
+ last4?: string;
2648
+ country?: string;
2649
+ exp_month?: number;
2650
+ exp_year?: number;
2651
+ funding?: string;
2652
+ };
2653
+ locale?: string;
2654
+ sessionId?: string;
2655
+ clientIp?: string;
2656
+ userAgent?: string;
2657
+ screenWidth?: number;
2658
+ visitId?: string;
2659
+ queryParameters?: {
2660
+ key: string;
2661
+ value: string;
2662
+ }[];
2663
+ stripePaymentIntentId?: string;
2664
+ stripePaymentIntentClientSecret?: string;
2665
+ stripeSetupIntentId?: string;
2666
+ /** Format: date-time */
2667
+ startDate?: string;
2668
+ /** Format: date-time */
2669
+ trialEnd?: string;
2670
+ /** Format: date-time */
2671
+ trialStart?: string;
2672
+ /** Format: date-time */
2673
+ cancelAt?: string;
2674
+ cancelAtPeriodEnd?: boolean;
2675
+ /** Format: date-time */
2676
+ currentPeriodStart?: string;
2677
+ /** Format: date-time */
2678
+ currentPeriodEnd?: string;
2679
+ upsell?: boolean;
2680
+ upsellPageId?: string;
2681
+ upsellChargeId?: string;
2682
+ upsellSubscriptionId?: string;
2683
+ stripeSubscriptionId?: string;
2684
+ stripeCustomerId?: string;
2685
+ sellerId?: string;
2686
+ customerId?: string;
2687
+ pageId?: string;
2688
+ productId?: string;
2689
+ /** Format: date-time */
2690
+ canceledAt?: string;
2691
+ canceledBy?: string;
2692
+ reason?: string;
2693
+ isAbandoned?: boolean;
2694
+ /** Format: date-time */
2695
+ recoveredAt?: string;
2696
+ /** @enum {string} */
2697
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
2698
+ /** Format: date-time */
2699
+ abandonedCartEmailSentAt?: string;
2700
+ /** Format: date-time */
2701
+ createdAt: string;
2702
+ /** Format: date-time */
2703
+ updatedAt: string;
2704
+ };
2705
+ };
2706
+ };
2707
+ };
2708
+ };
2709
+ responses: {
2710
+ /** @description Return a 200 status to indicate that the data was received successfully. */
2711
+ 200: {
2712
+ headers: {
2713
+ [name: string]: unknown;
2714
+ };
2715
+ content?: never;
2716
+ };
2717
+ };
2718
+ };
2719
+ "webhooks/subscription.active": {
2720
+ parameters: {
2721
+ query?: never;
2722
+ header?: never;
2723
+ path?: never;
2724
+ cookie?: never;
2725
+ };
2726
+ requestBody?: {
2727
+ content: {
2728
+ "application/json": {
2729
+ seller_id: string;
2730
+ /** Format: date-time */
2731
+ timestamp: string;
2732
+ /** @description Unique identifier for idempotency */
2733
+ event_id: string;
2734
+ /** @enum {string} */
2735
+ event: "subscription.active";
2736
+ data: {
2737
+ subscription: {
2738
+ id: string;
2739
+ orderId?: string;
2740
+ subscriptionId?: string;
2741
+ customerEmail?: string;
2742
+ currency?: string;
2743
+ amount: number;
2744
+ amountUsd?: number;
2745
+ interval?: string;
2746
+ intervalCount?: number;
2747
+ planIterations?: number;
2748
+ fees?: {
2749
+ name?: string;
2750
+ amount?: number;
2751
+ percentage?: number;
2752
+ stripeProductId?: string;
2753
+ }[];
2754
+ setupFee?: number;
2755
+ setupFeeDiscountAmount?: number;
2756
+ setupFeeFees?: {
2757
+ name?: string;
2758
+ amount?: number;
2759
+ percentage?: number;
2760
+ stripeInvoiceItemId?: string;
2761
+ }[];
2762
+ setupFeeTotal?: number;
2763
+ setupFeeUsd?: number;
2764
+ setupFeeInvoiceItemId?: string;
2765
+ setupFeeInvoiceItemPaid?: boolean;
2766
+ quantity?: number;
2767
+ productPrice?: number;
2768
+ dynamicPrice?: number;
2769
+ discountedFromPrice?: number;
2770
+ feePercentage?: number;
2771
+ sku?: string;
2772
+ billing?: {
2773
+ name?: string;
2774
+ companyName?: string;
2775
+ email?: string;
2776
+ billingEmail?: string;
2777
+ phone?: string;
2778
+ address?: {
2779
+ line1?: string;
2780
+ line2?: string;
2781
+ city?: string;
2782
+ state?: string;
2783
+ postalCode?: string;
2784
+ country?: string;
2785
+ };
2786
+ };
2787
+ shipping?: {
2788
+ name?: string;
2789
+ phone?: string;
2790
+ address?: {
2791
+ line1?: string;
2792
+ line2?: string;
2793
+ city?: string;
2794
+ state?: string;
2795
+ postalCode?: string;
2796
+ country?: string;
2797
+ };
2798
+ };
2799
+ fields?: {
2800
+ fieldId?: string;
2801
+ label?: string;
2802
+ value?: string;
2803
+ /** @enum {string} */
2804
+ element?: "checkbox" | "quantity" | "multiple-choice" | "select" | "po-number" | "text" | "textarea" | "number" | "date-time" | "date" | "time" | "email" | "tax-id" | "phone" | "country";
2805
+ /** @enum {string} */
2806
+ type?: "" | "company-name" | "po-number" | "name" | "first-name" | "last-name" | "email" | "billing-email" | "phone" | "address-line1" | "address-city" | "address-country" | "address-line2" | "address-postal_code" | "address-state" | "shipping-name" | "shipping-phone" | "shipping-address-line1" | "shipping-address-city" | "shipping-address-country" | "shipping-address-line2" | "shipping-address-postal_code" | "shipping-address-state" | "tax-id";
2807
+ reference?: string;
2808
+ }[];
2809
+ variants?: {
2810
+ name?: string;
2811
+ variantId?: string;
2812
+ reference?: string;
2813
+ /** @enum {string} */
2814
+ selectionType?: "single" | "multiple" | "quantity";
2815
+ selectedOptions?: {
2816
+ optionId?: string;
2817
+ /** @enum {string} */
2818
+ optionType?: "one_time" | "recurring";
2819
+ optionName?: string;
2820
+ sku?: string;
2821
+ quantity?: number;
2822
+ additionalChargeAmount?: number;
2823
+ discountAmount?: number;
2824
+ fees?: {
2825
+ name?: string;
2826
+ amount?: number;
2827
+ percentage?: number;
2828
+ stripeInvoiceItemId?: string;
2829
+ }[];
2830
+ additionalChargeAmountTotal?: number;
2831
+ additionalChargeAmountUsd?: number;
2832
+ optionStripePriceId?: string;
2833
+ optionStripeProductId?: string;
2834
+ optionInvoiceItemId?: string;
2835
+ optionInvoiceItemPaid?: boolean;
2836
+ }[];
2837
+ selectedOptionName?: string;
2838
+ additionalChargeAmount?: number;
2839
+ discountAmount?: number;
2840
+ fees?: {
2841
+ name?: string;
2842
+ amount?: number;
2843
+ percentage?: number;
2844
+ stripeInvoiceItemId?: string;
2845
+ }[];
2846
+ additionalChargeAmountTotal?: number;
2847
+ additionalChargeAmountUsd?: number;
2848
+ sku?: string;
2849
+ /** @enum {string} */
2850
+ selectedOptionType?: "one_time" | "recurring";
2851
+ selectedOptionId?: string;
2852
+ selectedOptionQuantity?: number;
2853
+ selectedOptionStripePriceId?: string;
2854
+ selectedOptionStripeProductId?: string;
2855
+ selectedOptionInvoiceItemId?: string;
2856
+ selectedOptionInvoiceItemPaid?: boolean;
2857
+ }[];
2858
+ couponId?: string;
2859
+ licenseKeyId?: string;
2860
+ livemode?: boolean;
2861
+ /** @enum {string} */
2862
+ status?: "draft" | "draft_expired" | "incomplete" | "incomplete_expired" | "trialing" | "scheduled" | "active" | "past_due" | "canceled" | "unpaid" | "failed" | "completed";
2863
+ /** @enum {string} */
2864
+ paymentStatus?: "draft" | "deleted" | "open" | "paid" | "uncollectible" | "void" | "requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded";
2865
+ paymentError?: string;
2866
+ paymentMethod?: {
2867
+ /** @enum {string} */
2868
+ gateway?: "stripe" | "paypal" | "manual";
2869
+ method?: string;
2870
+ wallet?: string;
2871
+ /** @enum {string} */
2872
+ mode?: "default" | "express";
2873
+ brand?: string;
2874
+ last4?: string;
2875
+ country?: string;
2876
+ exp_month?: number;
2877
+ exp_year?: number;
2878
+ funding?: string;
2879
+ };
2880
+ locale?: string;
2881
+ sessionId?: string;
2882
+ clientIp?: string;
2883
+ userAgent?: string;
2884
+ screenWidth?: number;
2885
+ visitId?: string;
2886
+ queryParameters?: {
2887
+ key: string;
2888
+ value: string;
2889
+ }[];
2890
+ stripePaymentIntentId?: string;
2891
+ stripePaymentIntentClientSecret?: string;
2892
+ stripeSetupIntentId?: string;
2893
+ /** Format: date-time */
2894
+ startDate?: string;
2895
+ /** Format: date-time */
2896
+ trialEnd?: string;
2897
+ /** Format: date-time */
2898
+ trialStart?: string;
2899
+ /** Format: date-time */
2900
+ cancelAt?: string;
2901
+ cancelAtPeriodEnd?: boolean;
2902
+ /** Format: date-time */
2903
+ currentPeriodStart?: string;
2904
+ /** Format: date-time */
2905
+ currentPeriodEnd?: string;
2906
+ upsell?: boolean;
2907
+ upsellPageId?: string;
2908
+ upsellChargeId?: string;
2909
+ upsellSubscriptionId?: string;
2910
+ stripeSubscriptionId?: string;
2911
+ stripeCustomerId?: string;
2912
+ sellerId?: string;
2913
+ customerId?: string;
2914
+ pageId?: string;
2915
+ productId?: string;
2916
+ /** Format: date-time */
2917
+ canceledAt?: string;
2918
+ canceledBy?: string;
2919
+ reason?: string;
2920
+ isAbandoned?: boolean;
2921
+ /** Format: date-time */
2922
+ recoveredAt?: string;
2923
+ /** @enum {string} */
2924
+ abandonedCartEmailStatus?: "pending" | "first_sent" | "second_sent" | "third_sent" | "converted" | "skipped";
2925
+ /** Format: date-time */
2926
+ abandonedCartEmailSentAt?: string;
2927
+ /** Format: date-time */
2928
+ createdAt: string;
2929
+ /** Format: date-time */
2930
+ updatedAt: string;
2931
+ };
2932
+ };
2933
+ };
2934
+ };
2935
+ };
2936
+ responses: {
2937
+ /** @description Return a 200 status to indicate that the data was received successfully. */
2938
+ 200: {
2939
+ headers: {
2940
+ [name: string]: unknown;
2941
+ };
2942
+ content?: never;
2943
+ };
2944
+ };
2945
+ };
2946
+ "webhooks/ticket.created": {
2947
+ parameters: {
2948
+ query?: never;
2949
+ header?: never;
2950
+ path?: never;
2951
+ cookie?: never;
2952
+ };
2953
+ requestBody?: {
2954
+ content: {
2955
+ "application/json": {
2956
+ seller_id: string;
2957
+ /** Format: date-time */
2958
+ timestamp: string;
2959
+ /** @description Unique identifier for idempotency */
2960
+ event_id: string;
2961
+ /** @enum {string} */
2962
+ event: "ticket.created";
2963
+ data: {
2964
+ ticket: {
2965
+ id: string;
2966
+ seller: string;
2967
+ charge: string;
2968
+ orderId: string;
2969
+ page: string;
2970
+ ticketType: string;
2971
+ originalPrice: number;
2972
+ discountAmount: number;
2973
+ feeAmount: number;
2974
+ taxAmount: number;
2975
+ couponAmount: number;
2976
+ revenue: number;
2977
+ currency?: string;
2978
+ customer: string;
2979
+ ticketShortId: string;
2980
+ /** @enum {string} */
2981
+ status: "PAID" | "CANCELED";
2982
+ checkIns: {
2983
+ /** @enum {string} */
2984
+ status: "UNCHECKEDIN" | "CHECKEDIN";
2985
+ /** @enum {string} */
2986
+ method: "QRSCAN" | "MANUAL";
2987
+ checkedInBy: string;
2988
+ /** Format: date-time */
2989
+ checkedInAt: string;
2990
+ }[];
2991
+ latestCheckIn?: {
2992
+ /** @enum {string} */
2993
+ status: "UNCHECKEDIN" | "CHECKEDIN";
2994
+ /** @enum {string} */
2995
+ method: "QRSCAN" | "MANUAL";
2996
+ checkedInBy: string;
2997
+ /** Format: date-time */
2998
+ checkedInAt: string;
2999
+ };
3000
+ customerName?: string;
3001
+ customerEmail: string;
3002
+ /** Format: date-time */
3003
+ orderedAt: string;
3004
+ /** Format: date-time */
3005
+ canceledAt?: string;
3006
+ metadata: {
3007
+ key: string;
3008
+ value: string;
3009
+ /** Format: date-time */
3010
+ addedAt: string;
3011
+ }[];
3012
+ /** Format: date-time */
3013
+ createdAt: string;
3014
+ /** Format: date-time */
3015
+ updatedAt: string;
3016
+ };
3017
+ };
3018
+ };
3019
+ };
3020
+ };
3021
+ responses: {
3022
+ /** @description Return a 200 status to indicate that the data was received successfully. */
3023
+ 200: {
3024
+ headers: {
3025
+ [name: string]: unknown;
3026
+ };
3027
+ content?: never;
3028
+ };
3029
+ };
3030
+ };
3031
+ }
3032
+
3033
+ /**
3034
+ * Type definitions for the CheckoutPage API
3035
+ *
3036
+ * This file exports commonly used types from the generated schema.
3037
+ * The full generated schema is available in ./generated/schema.ts
3038
+ */
3039
+
3040
+ type Customer = operations['customers/get']['responses'][200]['content']['application/json'];
3041
+ type Address = NonNullable<Customer['address']>;
3042
+ type Shipping = NonNullable<Customer['shipping']>;
3043
+
3044
+ declare class CustomerResource {
3045
+ private client;
3046
+ constructor(client: CheckoutPageClient);
3047
+ get(customerId: string): Promise<Customer>;
3048
+ }
3049
+
3050
+ declare class CheckoutPageError extends Error {
3051
+ constructor(message: string);
3052
+ }
3053
+ declare class AuthenticationError extends CheckoutPageError {
3054
+ constructor(message?: string);
3055
+ }
3056
+ declare class NotFoundError extends CheckoutPageError {
3057
+ constructor(message?: string);
3058
+ }
3059
+ declare class RateLimitError extends CheckoutPageError {
3060
+ constructor(message?: string);
3061
+ }
3062
+ declare class ValidationError extends CheckoutPageError {
3063
+ constructor(message?: string);
3064
+ }
3065
+ declare class APIError extends CheckoutPageError {
3066
+ readonly statusCode: number;
3067
+ readonly response?: unknown;
3068
+ constructor(message: string, statusCode: number, response?: unknown);
3069
+ }
3070
+
3071
+ declare class CheckoutPage {
3072
+ readonly customers: CustomerResource;
3073
+ private readonly client;
3074
+ constructor(options: CheckoutPageClientOptions);
3075
+ }
3076
+
3077
+ export { APIError, type Address, AuthenticationError, CheckoutPage, type CheckoutPageClientOptions, CheckoutPageError, type Customer, NotFoundError, RateLimitError, type Shipping, ValidationError };