File tree Expand file tree Collapse file tree 3 files changed +37
-0
lines changed Expand file tree Collapse file tree 3 files changed +37
-0
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ ' @clerk/types ' : patch
3
+ ---
4
+
5
+ Add jsdoc comments for ` payerType ` in ` CommercePlanResource ` .
Original file line number Diff line number Diff line change @@ -57,6 +57,22 @@ export interface CommercePlanResource extends ClerkResource {
57
57
isDefault : boolean ;
58
58
isRecurring : boolean ;
59
59
hasBaseFee : boolean ;
60
+ /**
61
+ * Specifies the subscriber type this plan is designed for.
62
+ *
63
+ * Each plan is exclusively created for either individual users or organizations,
64
+ * and cannot be used interchangeably.
65
+ *
66
+ * @type {['user'] | ['org'] }
67
+ * @example
68
+ * ```ts
69
+ * // For a user plan
70
+ * payerType: ['user']
71
+ *
72
+ * // For an organization plan
73
+ * payerType: ['org']
74
+ * ```
75
+ */
60
76
payerType : string [ ] ;
61
77
publiclyVisible : boolean ;
62
78
slug : string ;
Original file line number Diff line number Diff line change @@ -626,6 +626,22 @@ export interface CommercePlanJSON extends ClerkResourceJSON {
626
626
is_default : boolean ;
627
627
is_recurring : boolean ;
628
628
has_base_fee : boolean ;
629
+ /**
630
+ * Specifies the subscriber type this plan is designed for.
631
+ *
632
+ * Each plan is exclusively created for either individual users or organizations,
633
+ * and cannot be used interchangeably.
634
+ *
635
+ * @type {['user'] | ['org'] }
636
+ * @example
637
+ * ```ts
638
+ * // For a user plan
639
+ * payer_type: ['user']
640
+ *
641
+ * // For an organization plan
642
+ * payer_type: ['org']
643
+ * ```
644
+ */
629
645
payer_type : string [ ] ;
630
646
publicly_visible : boolean ;
631
647
slug : string ;
You can’t perform that action at this time.
0 commit comments