-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathapi.txt
More file actions
1560 lines (1420 loc) · 134 KB
/
Copy pathapi.txt
File metadata and controls
1560 lines (1420 loc) · 134 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
@userdashboard/dashboard 1.0.390
http://localhost:8000
|---------------------------------------------------------------|
| /account/subscriptions/cancel-subscription |
| EXCEPTIONS----------------------------------------------------|
| undefined |
| * should reject missing subscription |
| * should reject invalid subscription |
| * should reject canceled subscription |
| * should reject other account's subscription |
| before |
| * should bind data to req |
| view |
| * should present the form |
| * should show fields for free plan cancelations |
| * should show fields for free trial cancelations |
| * should show fields for cancelation with credit or refund |
| submit |
| * should cancel free subscription immediately (screenshots) |
| * should cancel free subscription at period end |
| * should cancel free trial immediately |
| * should cancel free trial at period end |
| * should cancel paid subscription and credit account |
| * should cancel paid subscription and show refund |
|---------------------------------------------------------------|
|----------------------------------------------|
| /account/subscriptions/confirm-subscription |
| EXCEPTIONS-----------------------------------|
| undefined |
| * invalid-planid (175ms) |
| * invalid-plan |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should start subscription (screenshots) |
| errors |
| * invalid-paymentmethodid |
|----------------------------------------------|
|-------------------------------------------------|
| /account/subscriptions/delete-billing-profile |
| EXCEPTIONS--------------------------------------|
| undefined |
| * invalid-customerid |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should delete billing profile (screenshots) |
|-------------------------------------------------|
|-----------------------------------------------|
| /account/subscriptions/invoice |
| EXCEPTIONS------------------------------------|
| undefined |
| * invalid-invoiceid |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should have row for invoice (screenshots) |
|-----------------------------------------------|
|--------------------------------------|
| /account/subscriptions/pay-invoice |
| EXCEPTIONS---------------------------|
| undefined |
| * should reject invalid invoice |
| * invalid-account |
| * should reject paid invoice |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should pay invoice (screenshots) |
|--------------------------------------|
|----------------------------------------------|
| /account/subscriptions/refund-invoice |
| EXCEPTIONS-----------------------------------|
| undefined |
| * invalid-invoiceid |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should cancel subscription (screenshots) |
|----------------------------------------------|
|------------------------------------------------|
| /account/subscriptions/request-refund |
| EXCEPTIONS-------------------------------------|
| undefined |
| * invalid-invoice |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should create refund request (screenshots) |
|------------------------------------------------|
|---------------------------------------------------------|
| /account/subscriptions/subscription |
| EXCEPTIONS----------------------------------------------|
| undefined |
| * invalid-subscriptionid (655ms) |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the subscription table (screenshots) |
|---------------------------------------------------------|
|-----------------------------------------------------|
| /administrator/subscriptions/apply-customer-coupon |
| EXCEPTIONS------------------------------------------|
| undefined |
| * should reject invalid customer (161ms) |
| * should reject customer with coupon (2021ms) |
| before |
| * should bind data to req (773ms) |
| view |
| * should present the form (1584ms) |
| submit |
| * should apply coupon (screenshots) (32409ms) |
|-----------------------------------------------------|
|---------------------------------------------------------|
| /administrator/subscriptions/apply-subscription-coupon |
| EXCEPTIONS----------------------------------------------|
| undefined |
| * should reject invalid subscription (159ms) |
| * should reject canceling subscription (8698ms) |
| * should reject free subscription (6170ms) |
| * should reject subscription with coupon (7819ms) |
| before |
| * should bind data to req (8201ms) |
| view |
| * should present the form (9020ms) |
| submit |
| * should apply coupon (screenshots) (37454ms) |
|---------------------------------------------------------|
|--------------------------------------------------|
| /administrator/subscriptions/delete-coupon |
| EXCEPTIONS---------------------------------------|
| undefined |
| * should reject invalid couponid (156ms) |
| before |
| * should bind data to req (313ms) |
| view |
| * should present the form (817ms) |
| submit |
| * should delete coupon (screenshots) (32041ms) |
|--------------------------------------------------|
|------------------------------------------------|
| /administrator/subscriptions/delete-plan |
| EXCEPTIONS-------------------------------------|
| undefined |
| * should reject invalid planid (148ms) |
| before |
| * should bind data to req (643ms) |
| view |
| * should present the form (1116ms) |
| submit |
| * should delete plan (screenshots) (32440ms) |
|------------------------------------------------|
|---------------------------------------------------|
| /administrator/subscriptions/delete-product |
| EXCEPTIONS----------------------------------------|
| undefined |
| * should reject invalid productid (174ms) |
| before |
| * should bind data to req (302ms) |
| view |
| * should present the form (764ms) |
| submit |
| * should delete product (screenshots) (31046ms) |
|---------------------------------------------------|
|------------------------------------------------------------------------|
| /administrator/subscriptions/delete-subscription |
| EXCEPTIONS-------------------------------------------------------------|
| undefined |
| * should reject missing subscription |
| * should reject invalid subscription |
| * should reject canceled subscription |
| before |
| * should bind data to req |
| view |
| * should present the form |
| * should show fields for free plan cancelations |
| * should show fields for free trial cancelations |
| * should show fields for cancelation with credit or refund |
| submit |
| * should cancel free subscription immediately (screenshots) (5246ms) |
| * should cancel free subscription at period end |
| * should cancel free trial immediately |
| * should cancel free trial at period end |
| * should cancel paid subscription and credit account |
| * should cancel paid subscription and show refund |
|------------------------------------------------------------------------|
|----------------------------------------------------------|
| /administrator/subscriptions/deny-refund |
| EXCEPTIONS-----------------------------------------------|
| undefined |
| * should reject invalid chargeid (163ms) |
| * should reject charge without refund request (8403ms) |
| * should reject denied refund (8191ms) |
| before |
| * should bind data to req (7345ms) |
| view |
| * should present the form (8925ms) |
| submit |
| * should deny refund (screenshots) (44848ms) |
|----------------------------------------------------------|
|--------------------------------------------|
| /administrator/subscriptions/flag-charge |
| EXCEPTIONS---------------------------------|
| undefined |
| * should reject invalid chargeid (166ms) |
| * should reject flagged charge |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should flag charge (screenshots) |
|--------------------------------------------|
|----------------------------------------------------|
| /administrator/subscriptions/forgive-invoice |
| EXCEPTIONS-----------------------------------------|
| undefined |
| * should reject invalid invoiceid (154ms) |
| * should reject paid invoice (7129ms) |
| * should reject uncollectible invoice (3491ms) |
| before |
| * should bind data to req (2427ms) |
| view |
| * should present the form (2948ms) |
| submit |
| * should forgive invoice (screenshots) (31593ms) |
|----------------------------------------------------|
|---------------------------------------------------|
| /administrator/subscriptions/publish-coupon |
| EXCEPTIONS----------------------------------------|
| undefined |
| * should reject invalid couponid (165ms) |
| * should reject published coupon (309ms) |
| before |
| * should bind data to req (297ms) |
| view |
| * should present the form (808ms) |
| submit |
| * should publish coupon (screenshots) (31625ms) |
|---------------------------------------------------|
|-------------------------------------------------|
| /administrator/subscriptions/publish-plan |
| EXCEPTIONS--------------------------------------|
| undefined |
| * should reject invalid planid (157ms) |
| * should reject published plan (632ms) |
| before |
| * should bind data to req (631ms) |
| view |
| * should present the form (1120ms) |
| submit |
| * should publish plan (screenshots) (32068ms) |
|-------------------------------------------------|
|----------------------------------------------------|
| /administrator/subscriptions/publish-product |
| EXCEPTIONS-----------------------------------------|
| undefined |
| * should reject invalid productid (169ms) |
| * should reject published product (330ms) |
| before |
| * should bind data to req (359ms) |
| view |
| * should present the form (797ms) |
| submit |
| * should publish product (screenshots) (30878ms) |
|----------------------------------------------------|
|---------------------------------------------|
| /administrator/subscriptions/refund-charge |
| EXCEPTIONS----------------------------------|
| undefined |
| * should reject invalid chargeid (159ms) |
| * should reject refunded charge |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should refund charge (screenshots) |
|---------------------------------------------|
|------------------------------------------------------|
| /administrator/subscriptions/revoke-customer-coupon |
| EXCEPTIONS-------------------------------------------|
| undefined |
| * should reject invalid customer (164ms) |
| * should reject customer without discount (952ms) |
| before |
| * should bind data to req (1314ms) |
| view |
| * should present the form (1979ms) |
| submit |
| * should remove coupon (screenshots) (31296ms) |
|------------------------------------------------------|
|----------------------------------------------------------|
| /administrator/subscriptions/revoke-subscription-coupon |
| EXCEPTIONS-----------------------------------------------|
| undefined |
| * should reject invalid subscription (167ms) |
| * should reject subscription without discount (9310ms) |
| before |
| * should bind data to req (8470ms) |
| view |
| * should present the form (10657ms) |
| submit |
| * should remove coupon (screenshots) (38999ms) |
|----------------------------------------------------------|
|-----------------------------------------------------|
| /administrator/subscriptions/unpublish-coupon |
| EXCEPTIONS------------------------------------------|
| undefined |
| * should reject invalid couponid (153ms) |
| * should reject never published coupon (319ms) |
| * should reject unpublished coupon (533ms) |
| before |
| * should bind data to req (364ms) |
| view |
| * should present the form (783ms) |
| submit |
| * should unpublish coupon (screenshots) (31674ms) |
|-----------------------------------------------------|
|---------------------------------------------------|
| /administrator/subscriptions/unpublish-plan |
| EXCEPTIONS----------------------------------------|
| undefined |
| * should reject invalid planid (169ms) |
| * should never published plan (610ms) |
| * should reject unpublished plan (868ms) |
| before |
| * should bind data to req (647ms) |
| view |
| * should present the form (1109ms) |
| submit |
| * should unpublish plan (screenshots) (31933ms) |
|---------------------------------------------------|
|------------------------------------------------------|
| /administrator/subscriptions/unpublish-product |
| EXCEPTIONS-------------------------------------------|
| undefined |
| * should reject invalid productid (154ms) |
| * should never published product (298ms) |
| * should reject unpublished product (448ms) |
| before |
| * should bind data to req (297ms) |
| view |
| * should present the form (775ms) |
| submit |
| * should unpublish product (screenshots) (30845ms) |
|------------------------------------------------------|
|----------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/charge |
| RECEIVES-----------------------| RETURNS----------| EXCEPTIONS-------------------------------|
| required querystring chargeid | object (7217ms) | invalid-chargeid |
| | | * missing querystring chargeid |
| | | * invalid querystring chargeid (175ms) |
|--------------------------------|------------------|------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/charges |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|-------------------------------------------------|
| /api/administrator/subscriptions/charges-count |
| RETURNS-----------------------------------------|
| integer (23669ms) |
|-------------------------------------------------|
|---------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/coupon |
| RECEIVES-----------------------| RETURNS---------| EXCEPTIONS-------------------------------|
| required querystring couponid | object (315ms) | invalid-couponid |
| | | * missing querystring couponid |
| | | * invalid querystring couponid (152ms) |
|--------------------------------|-----------------|------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/coupons |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|-------------------------------------------------|
| /api/administrator/subscriptions/coupons-count |
| RETURNS-----------------------------------------|
| integer (517ms) |
|-------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/create-cancelation-refund |
| RECEIVES-----------------------------| RETURNS----------| EXCEPTIONS-----------------------------------------------------|
| required querystring subscriptionid | object (9680ms) | invalid-subscriptionid |
| | | * missing querystring subscriptionid |
| | | * invalid querystring subscriptionid (163ms) |
| | | invalid-subscription |
| | | * ineligible querystring subscription is not active (8660ms) |
|--------------------------------------|------------------|----------------------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/create-coupon |
| RECEIVES---------------------------------------------------------| RETURNS---------| EXCEPTIONS---------------------------------------|
| required posted duration_in_months | object (185ms) | invalid-couponid |
| required posted currency | | * missing posted couponid |
| required posted amount_off | | * invalid posted couponid is not alphanumeric_ |
| required posted couponid | | invalid-amount_off |
| required posted duration | | * missing posted amount_off |
| optionally-required posted amount_off (integer, or percent_off) | | * invalid posted amount_off |
| optionally-required posted currency (string, if amount_off) | | invalid-currency |
| optionally-required posted percent_off (integer, or amount_off) | | * missing posted currency |
| optionally-required posted expire date | | * invalid posted currency |
| optionally-required posted duration_in_months | | invalid-percent_off |
| | | * invalid posted percent_off |
| | | invalid-duration |
| | | * invalid posted duration |
| | | invalid-duration_in_months |
| | | * missing posted duration_in_months |
| | | * invalid posted duration_in_months |
| | | invalid-redeem_by_meridiem |
| | | * invalid posted redeem_by_meridiem |
| | | invalid-redeem_by |
| | | * invalid posted redeem_by |
|------------------------------------------------------------------|-----------------|--------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/create-plan |
| RECEIVES-----------------------------------------------| RETURNS---------| EXCEPTIONS---------------------------------------------| CONFIGURATION------------------------------|
| required posted interval_count (298ms) | object (504ms) | invalid-planid | environment MINIMUM_PLANID_LENGTH (175ms) |
| required posted interval (395ms) | | * invalid posted planid is not alphanumeric_ (201ms) | environment MAXIMUM_PLANID_LENGTH (277ms) |
| required posted currency (168ms) | | invalid-planid-length | |
| required posted amount (282ms) | | * posted planid is too short (193ms) | |
| required posted productid (191ms) | | * posted planid is too long (178ms) | |
| optional posted published (boolean) (544ms) | | invalid-productid | |
| optional posted trial_period_days (integer) (490ms) | | * missing posted productid (191ms) | |
| optional posted usage_type (licensed|metered) (502ms) | | * invalid posted productid (330ms) | |
| | | invalid-product | |
| | | * ineligible posted product is not published (303ms) | |
| | | invalid-amount | |
| | | * missing posted amount (282ms) | |
| | | * invalid posted amount (568ms) | |
| | | invalid-currency | |
| | | * missing posted currency (168ms) | |
| | | * invalid posted currency (163ms) | |
| | | invalid-interval | |
| | | * missing posted interval (395ms) | |
| | | * invalid posted interval (306ms) | |
| | | invalid-interval-count | |
| | | * missing posted interval_count (298ms) | |
| | | * invalid posted interval_count (325ms) | |
| | | invalid-trial_period | |
| | | * invalid posted trial_period (339ms) | |
| | | invalid-usage_type | |
| | | * invalid posted usage_type (308ms) | |
|--------------------------------------------------------|-----------------|--------------------------------------------------------|--------------------------------------------|
|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/create-product |
| RECEIVES-------------------------------------| RETURNS---------| EXCEPTIONS------------------------------| CONFIGURATION----------------------------|
| required posted statement_descriptor | object (360ms) | invalid-name | environment MINIMUM_PRODUCT_NAME_LENGTH |
| required posted name | | * missing posted name | environment MAXIMUM_PRODUCT_NAME_LENGTH |
| optional posted published (boolean) (350ms) | | invalid-product-name-length | |
| | | * posted name too short | |
| | | * posted name too long | |
| | | invalid-statement_descriptor | |
| | | * missing posted statement_descriptor | |
|----------------------------------------------|-----------------|-----------------------------------------|------------------------------------------|
|--------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/create-refund |
| RECEIVES-----------------------| RETURNS--| EXCEPTIONS-------------------------------|
| required posted amount | object | invalid-chargeid |
| required querystring chargeid | | * missing querystring chargeid |
| | | * invalid querystring chargeid (154ms) |
| | | invalid-amount |
| | | * missing posted amount |
| | | * invalid posted amount |
| | | * invalid posted amount is negative |
| | | * invalid posted amount exceeds charge |
|--------------------------------|----------|------------------------------------------|
|--------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/customer |
| RECEIVES-------------------------| RETURNS----------| EXCEPTIONS---------------------------------|
| required querystring customerid | object (3047ms) | invalid-customerid |
| | | * missing querystring customerid |
| | | * invalid querystring customerid (162ms) |
|----------------------------------|------------------|--------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/customers |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|---------------------------------------------------|
| /api/administrator/subscriptions/customers-count |
| RETURNS-------------------------------------------|
| integer (551ms) |
|---------------------------------------------------|
|----------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/delete-coupon |
| RECEIVES-----------------------| RETURNS----------| EXCEPTIONS-------------------------------|
| required querystring couponid | boolean (490ms) | invalid-couponid |
| | | * missing querystring couponid |
| | | * invalid querystring couponid (157ms) |
|--------------------------------|------------------|------------------------------------------|
|------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/delete-plan |
| RECEIVES---------------------| RETURNS----------| EXCEPTIONS-----------------------------|
| required querystring planid | boolean (853ms) | invalid-planid |
| | | * missing querystring planid |
| | | * invalid querystring planid (166ms) |
|------------------------------|------------------|----------------------------------------|
|------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/delete-product |
| RECEIVES------------------------| RETURNS----------| EXCEPTIONS--------------------------------|
| required querystring productid | boolean (490ms) | invalid-productid |
| | | * missing querystring productid |
| | | * invalid querystring productid (156ms) |
|---------------------------------|------------------|-------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/delete-subscription |
| RECEIVES-----------------------------| RETURNS-----------| EXCEPTIONS-----------------------------------------------------|
| required querystring subscriptionid | boolean (8000ms) | invalid-subscriptionid |
| | | * missing querystring subscriptionid |
| | | * invalid querystring subscriptionid (163ms) |
| | | invalid-subscription |
| | | * ineligible querystring subscription is not active (8659ms) |
|--------------------------------------|-------------------|----------------------------------------------------------------|
|------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/invoice |
| RECEIVES------------------------| RETURNS----------| EXCEPTIONS--------------------------------|
| required querystring invoiceid | object (6929ms) | invalid-invoiceid |
| | | * missing querystring invoiceid |
| | | * invalid querystring invoiceid (158ms) |
|---------------------------------|------------------|-------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/invoices |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|--------------------------------------------------|
| /api/administrator/subscriptions/invoices-count |
| RETURNS------------------------------------------|
| integer (30361ms) |
|--------------------------------------------------|
|----------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/payment-intent |
| RECEIVES------------------------------| RETURNS----------| EXCEPTIONS------------------------------|
| required querystring paymentintentid | object (2184ms) | invalid-paymentintentid |
| | | * missing querystring paymentintentid |
| | | * invalid querystring paymentintentid |
|---------------------------------------|------------------|-----------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/payment-intents |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|---------------------------------------------------------|
| /api/administrator/subscriptions/payment-intents-count |
| RETURNS-------------------------------------------------|
| integer (5415ms) |
|---------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/payment-method |
| RECEIVES-------------------------------------| RETURNS----------| EXCEPTIONS-------------------------------------|
| required querystring paymentmethodid (41ms) | object (1637ms) | invalid-paymentmethodid |
| | | * missing querystring paymentmethodid (41ms) |
| | | * invalid querystring paymentmethodid |
|----------------------------------------------|------------------|------------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/payment-methods |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|---------------------------------------------------------|
| /api/administrator/subscriptions/payment-methods-count |
| RETURNS-------------------------------------------------|
| integer (4183ms) |
|---------------------------------------------------------|
|-----------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/plan |
| RECEIVES---------------------| RETURNS---------| EXCEPTIONS-----------------------------|
| required querystring planid | object (783ms) | invalid-planid |
| | | * missing querystring planid |
| | | * invalid querystring planid (163ms) |
|------------------------------|-----------------|----------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/plans |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|-----------------------------------------------|
| /api/administrator/subscriptions/plans-count |
| RETURNS---------------------------------------|
| integer (889ms) |
|-----------------------------------------------|
|-----------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/product |
| RECEIVES------------------------| RETURNS---------| EXCEPTIONS--------------------------------|
| required querystring productid | object (299ms) | invalid-productid |
| | | * missing querystring productid |
| | | * invalid querystring productid (162ms) |
|---------------------------------|-----------------|-------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/products |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|--------------------------------------------------|
| /api/administrator/subscriptions/products-count |
| RETURNS------------------------------------------|
| integer (542ms) |
|--------------------------------------------------|
|------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/refund |
| RECEIVES-------------------------------| RETURNS----------| EXCEPTIONS-------------------------------|
| required querystring refundid (164ms) | object (9173ms) | undefined |
| | | * invalid querystring refundid |
| | | * missing querystring refundid (164ms) |
|----------------------------------------|------------------|------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/refund-requests |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|---------------------------------------------------------|
| /api/administrator/subscriptions/refund-requests-count |
| RETURNS-------------------------------------------------|
| integer (24692ms) |
|---------------------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/refunds |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|-------------------------------------------------|
| /api/administrator/subscriptions/refunds-count |
| RETURNS-----------------------------------------|
| integer (27941ms) |
|-------------------------------------------------|
|---------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/reset-customer-coupon |
| RECEIVES-------------------------| EXCEPTIONS-----------------------------------------------|
| required querystring customerid | invalid-customerid |
| object (1073ms) | * missing querystring customerid |
| | * invalid querystring customerid (160ms) |
| | invalid-customeir |
| | * invalid querystring customer has no discount (293ms) |
|----------------------------------|----------------------------------------------------------|
|-----------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/reset-subscription-coupon |
| RECEIVES-----------------------------| RETURNS-----------| EXCEPTIONS-------------------------------------------------------|
| required querystring subscriptionid | object (10298ms) | invalid-subscriptionid |
| | | * missing querystring subscriptionid |
| | | * invalid querystring subscriptionid (220ms) |
| | | invalid-subscription |
| | | * ineligible querystring subscription has no discount (8260ms) |
|--------------------------------------|-------------------|------------------------------------------------------------------|
|-----------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-charge-flagged |
| RECEIVES---------------------| RETURNS----------| EXCEPTIONS----------------------------------------------------|
| required querystring charge | object (7507ms) | invalid-chargeid |
| | | * missing querystring charge |
| | | * invalid querystring charge (153ms) |
| | | invalid-charge |
| | | * ineligible querystring charge is already flagged (8240ms) |
|------------------------------|------------------|---------------------------------------------------------------|
|-------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-coupon-published |
| RECEIVES-----------------------| RETURNS---------| EXCEPTIONS-----------------------------------------------|
| required querystring couponid | object (506ms) | invalid-couponid |
| | | * missing querystring couponid |
| | | * invalid querystring couponid (152ms) |
| | | invalid-coupon |
| | | * ineligible querystring coupon is published (307ms) |
| | | * ineligible querystring coupon is unpublished (301ms) |
|--------------------------------|-----------------|----------------------------------------------------------|
|----------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-coupon-unpublished |
| RECEIVES------------------------------| RETURNS---------| EXCEPTIONS-------------------------------------------------------|
| required querystring couponid (47ms) | object (496ms) | invalid-couponid |
| | | * missing querystring couponid (47ms) |
| | | * invalid querystring couponid (158ms) |
| | | invalid-coupon |
| | | * ineligible querystring coupon is not published (327ms) |
| | | * ineligible querystring coupon is already unpublished (483ms) |
|---------------------------------------|-----------------|------------------------------------------------------------------|
|-------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-invoice-uncollectible |
| RECEIVES--------------------------------| RETURNS----------| EXCEPTIONS-------------------------------------------------------|
| required querystring invoiceid (337ms) | object (4958ms) | invalid-invoiceid |
| | | * missing querystring invoiceid (337ms) |
| | | * invalid querystring invoiceid (150ms) |
| | | invalid-invoice |
| | | * invalid querystring invoice is paid (8226ms) |
| | | * invalid querystring invoice is marked uncollectable (5587ms) |
|-----------------------------------------|------------------|------------------------------------------------------------------|
|-------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-plan-published |
| RECEIVES---------------------| RETURNS---------| EXCEPTIONS-------------------------------------------|
| required querystring planid | object (823ms) | invalid-planid |
| | | * missing querystring planid |
| | | * invalid querystring planid (161ms) |
| | | invalid-plan |
| | | * ineligible querystring plan is published (630ms) |
|------------------------------|-----------------|------------------------------------------------------|
|-----------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-plan-unpublished |
| RECEIVES---------------------| RETURNS---------| EXCEPTIONS-----------------------------------------------------|
| required querystring planid | object (865ms) | invalid-planid |
| | | * missing querystring planid |
| | | * invalid querystring planid (151ms) |
| | | invalid-plan |
| | | * ineligible querystring plan is not published (637ms) |
| | | * ineligible querystring plan is already unpublished (827ms) |
|------------------------------|-----------------|----------------------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-product-published |
| RECEIVES--------------------------------| RETURNS---------| EXCEPTIONS---------------------------------------------------|
| required querystring productid (325ms) | object (486ms) | invalid-productid |
| | | * missing querystring productid (325ms) |
| | | * invalid querystring productid (305ms) |
| | | invalid-product |
| | | * invalid querystring product is already published (320ms) |
|-----------------------------------------|-----------------|--------------------------------------------------------------|
|-------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-product-unpublished |
| RECEIVES--------------------------------| RETURNS---------| EXCEPTIONS--------------------------------------------------------|
| required querystring productid (176ms) | object (488ms) | invalid-productid |
| | | * missing querystring productid (176ms) |
| | | * invalid querystring productid (328ms) |
| | | invalid-product |
| | | * ineligible querystring product is not published (335ms) |
| | | * ineligible querystring product is already unpublished (503ms) |
|-----------------------------------------|-----------------|-------------------------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-refund-request-denied |
| RECEIVES-----------------------| RETURNS----------| EXCEPTIONS------------------------------------------------------------|
| required querystring chargeid | object (7809ms) | invalid-chargeid |
| | | * missing querystring chargeid |
| | | * invalid querystring chargeid (166ms) |
| | | invalid-charge |
| | | * ineligible querystring charge has no refund request (7652ms) |
| | | * ineligible querystring charge has denied request already (9046ms) |
|--------------------------------|------------------|-----------------------------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-subscription-canceled |
| RECEIVES-----------------------------| RETURNS----------| EXCEPTIONS-----------------------------------------------------|
| required querystring subscriptionid | object (8226ms) | invalid-subscriptionid |
| | | * missing querystring subscriptionid |
| | | * invalid querystring subscriptionid (406ms) |
| | | invalid-subscription |
| | | * ineligible querystring subscription is not active (9367ms) |
|--------------------------------------|------------------|----------------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/set-subscription-coupon |
| RECEIVES-----------------------------| RETURNS----------| EXCEPTIONS---------------------------------------------|
| required posted couponid (8088ms) | object (9794ms) | invalid-subscriptionid |
| required querystring subscriptionid | | * missing querystring subscriptionid |
| | | * invalid querystring subscriptionid |
| | | invalid-subscription |
| | | * ineligible subscription is canceling (9550ms) |
| | | * ineligible subscription has coupon (9651ms) |
| | | invalid-couponid |
| | | * missing posted couponid (8088ms) |
| | | * invalid posted couponid (8059ms) |
| | | invalid-coupon |
| | | * ineligible posted coupon is not published (7844ms) |
| | | * ineligible posted coupon is unpublished (8960ms) |
|--------------------------------------|------------------|--------------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/setup-intent |
| RECEIVES-----------------------------------| RETURNS----------| EXCEPTIONS-----------------------------------|
| required querystring setupintentid (39ms) | object (3193ms) | invalid-setupintentid |
| | | * missing querystring setupintentid (39ms) |
| | | * invalid querystring setupintentid |
|--------------------------------------------|------------------|----------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/setup-intents |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|-------------------------------------------------------|
| /api/administrator/subscriptions/setup-intents-count |
| RETURNS-----------------------------------------------|
| integer (4125ms) |
|-------------------------------------------------------|
|----------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/subscription |
| RECEIVES-----------------------------| RETURNS----------| EXCEPTIONS-------------------------------------|
| required querystring subscriptionid | object (7269ms) | invalid-subscriptionid |
| | | * missing querystring subscriptionid |
| | | * invalid querystring subscriptionid (171ms) |
|--------------------------------------|------------------|------------------------------------------------|
|----------------------------------------------------------------------------|
| /api/administrator/subscriptions/subscriptions |
| RECEIVES-------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
|----------------------------------------|----------|------------------------|
|-------------------------------------------------------|
| /api/administrator/subscriptions/subscriptions-count |
| RETURNS-----------------------------------------------|
| integer (25819ms) |
|-------------------------------------------------------|
|-------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/update-coupon |
| RECEIVES-----------------------| RETURNS---------| EXCEPTIONS-----------------------------------------------|
| required posted name (315ms) | object (511ms) | invalid-couponid |
| required querystring couponid | | * missing querystring couponid |
| required posted name (476ms) | | * invalid querystring couponid (162ms) |
| | | invalid-coupon |
| | | * ineligible querystring coupon is unpublished (486ms) |
| | | invalid-name |
| | | * missing posted name (315ms) |
| | | * invalid posted name (407ms) |
|--------------------------------|-----------------|----------------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/update-plan |
| RECEIVES---------------------------------------------| RETURNS----------| EXCEPTIONS-------------------------------------------------------|
| required querystring planid | object (1080ms) | invalid-planid |
| optional posted trial_period_days (integer) (826ms) | | * missing querystring planid |
| | | * invalid querystring planid (151ms) |
| | | invalid-plan |
| | | * ineligible querystring plan is unpublished (977ms) |
| | | invalid-productid |
| | | * invalid posted productid (765ms) |
| | | invalid-product |
| | | * ineligible posted product is not published (939ms) |
| | | * ineligible posted product is unpublished (1154ms) |
| | | invalid-trial_period_days |
| | | * invalid posted trial_period_days (885ms) |
| | | * ineligible posted trial_period_days is negative (1107ms) |
| | | * ineligible posted trial_period_days greater than 365 (808ms) |
|------------------------------------------------------|------------------|------------------------------------------------------------------|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/update-product |
| RECEIVES--------------------------------------| RETURNS---------| EXCEPTIONS------------------------------------------------| CONFIGURATION------------------------------------|
| required posted unit_label (317ms) | object (486ms) | invalid-productid | environment MINIMUM_PRODUCT_NAME_LENGTH (322ms) |
| required querystring productid (192ms) | | * missing querystring productid (192ms) | environment MAXIMUM_PRODUCT_NAME_LENGTH (336ms) |
| optional posted name (503ms) | | * invalid querystring productid (305ms) | |
| optional posted statement_descriptor (502ms) | | invalid-product | |
| optional posted unit_label (461ms) | | * ineligible querystring product is unpublished (480ms) | |
| | | invalid-name | |
| | | * invalid posted name (292ms) | |
| | | invalid-name-length | |
| | | * posted name too short (319ms) | |
| | | * posted name too long (301ms) | |
| | | invalid-statement_descriptor | |
| | | * invalid posted statement_descriptor (327ms) | |
| | | invalid-statement_descriptor-length | |
| | | * posted statement_descriptor too short (315ms) | |
| | | * posted statement_descriptor too long (289ms) | |
| | | invalid-unit_label | |
| | | * missing posted unit_label (317ms) | |
|-----------------------------------------------|-----------------|-----------------------------------------------------------|--------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/subscriptions/usage-record-summaries |
| RECEIVES--------------------------------------| RETURNS---------------| EXCEPTIONS---------------------------------| CONFIGURATION----------|
| required querystring subscriptionitemid | stripe list response | invalid-subscriptionitemid | environment PAGE_SIZE |
| optional querystring starting_after (string) | | * missing querystring subscriptionitemid | |
| optional querystring ending_before (string) | | * invalid querystring subscriptionitemid | |
| optional querystring limit (integer) | | | |
|-----------------------------------------------|-----------------------|--------------------------------------------|------------------------|
|------------------------------------------------------------------------------------------------|
| /api/user/subscriptions/charge |
| RECEIVES-----------------------| RETURNS----------| EXCEPTIONS---------------------------------|
| required querystring chargeid | object (7730ms) | invalid-chargeid |
| | | * missing querystring chargeid |
| | | * invalid querystring chargeid |
| | | invalid-account |
| | | * ineligible accessing account (15274ms) |
|--------------------------------|------------------|--------------------------------------------|
|----------------------------------------------------------------------------------------------------------------------|
| /api/user/subscriptions/charges |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS------------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| | | * ineligible accessing account (39ms) | |
|----------------------------------------|----------|-----------------------------------------|------------------------|
|----------------------------------------|
| /api/user/subscriptions/charges-count |
| RETURNS--------------------------------|
| integer (15805ms) |
|----------------------------------------|