diff --git a/.changeset/bumpy-jobs-flow.md b/.changeset/bumpy-jobs-flow.md new file mode 100644 index 00000000000..a799d38b477 --- /dev/null +++ b/.changeset/bumpy-jobs-flow.md @@ -0,0 +1,5 @@ +--- +'@clerk/types': patch +--- + +Add jsdoc comments for `payerType` in `CommercePlanResource`. diff --git a/packages/types/src/commerce.ts b/packages/types/src/commerce.ts index ea041db90d9..e8d36d86573 100644 --- a/packages/types/src/commerce.ts +++ b/packages/types/src/commerce.ts @@ -57,6 +57,22 @@ export interface CommercePlanResource extends ClerkResource { isDefault: boolean; isRecurring: boolean; hasBaseFee: boolean; + /** + * Specifies the subscriber type this plan is designed for. + * + * Each plan is exclusively created for either individual users or organizations, + * and cannot be used interchangeably. + * + * @type {['user'] | ['org']} + * @example + * ```ts + * // For a user plan + * payerType: ['user'] + * + * // For an organization plan + * payerType: ['org'] + * ``` + */ payerType: string[]; publiclyVisible: boolean; slug: string; diff --git a/packages/types/src/json.ts b/packages/types/src/json.ts index 779d0807f0c..89917b5d2a9 100644 --- a/packages/types/src/json.ts +++ b/packages/types/src/json.ts @@ -626,6 +626,22 @@ export interface CommercePlanJSON extends ClerkResourceJSON { is_default: boolean; is_recurring: boolean; has_base_fee: boolean; + /** + * Specifies the subscriber type this plan is designed for. + * + * Each plan is exclusively created for either individual users or organizations, + * and cannot be used interchangeably. + * + * @type {['user'] | ['org']} + * @example + * ```ts + * // For a user plan + * payer_type: ['user'] + * + * // For an organization plan + * payer_type: ['org'] + * ``` + */ payer_type: string[]; publicly_visible: boolean; slug: string;