From c7d8d5dabf974aa992fb2122d7b3df1bee128770 Mon Sep 17 00:00:00 2001 From: panteliselef Date: Fri, 4 Jul 2025 14:31:44 +0300 Subject: [PATCH 1/3] chore(types): Add jsdoc for `payer_type` --- packages/types/src/commerce.ts | 16 ++++++++++++++++ packages/types/src/json.ts | 16 ++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/packages/types/src/commerce.ts b/packages/types/src/commerce.ts index ea041db90d9..8af51864261 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'] | ['organization']} + * @example + * ```ts + * // For a user plan + * payerType: ['user'] + * + * // For an organization plan + * payerType: ['organization'] + * ``` + */ payerType: string[]; publiclyVisible: boolean; slug: string; diff --git a/packages/types/src/json.ts b/packages/types/src/json.ts index 779d0807f0c..474dd9c3dd8 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'] | ['organization']} + * @example + * ```ts + * // For a user plan + * payer_type: ['user'] + * + * // For an organization plan + * payer_type: ['organization'] + * ``` + */ payer_type: string[]; publicly_visible: boolean; slug: string; From 5d2a705040813b233ab2856a0082bdf41f331e22 Mon Sep 17 00:00:00 2001 From: panteliselef Date: Fri, 4 Jul 2025 18:51:49 +0300 Subject: [PATCH 2/3] Apply suggestions from code review --- packages/types/src/commerce.ts | 4 ++-- packages/types/src/json.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/types/src/commerce.ts b/packages/types/src/commerce.ts index 8af51864261..e8d36d86573 100644 --- a/packages/types/src/commerce.ts +++ b/packages/types/src/commerce.ts @@ -63,14 +63,14 @@ export interface CommercePlanResource extends ClerkResource { * Each plan is exclusively created for either individual users or organizations, * and cannot be used interchangeably. * - * @type {['user'] | ['organization']} + * @type {['user'] | ['org']} * @example * ```ts * // For a user plan * payerType: ['user'] * * // For an organization plan - * payerType: ['organization'] + * payerType: ['org'] * ``` */ payerType: string[]; diff --git a/packages/types/src/json.ts b/packages/types/src/json.ts index 474dd9c3dd8..89917b5d2a9 100644 --- a/packages/types/src/json.ts +++ b/packages/types/src/json.ts @@ -632,14 +632,14 @@ export interface CommercePlanJSON extends ClerkResourceJSON { * Each plan is exclusively created for either individual users or organizations, * and cannot be used interchangeably. * - * @type {['user'] | ['organization']} + * @type {['user'] | ['org']} * @example * ```ts * // For a user plan * payer_type: ['user'] * * // For an organization plan - * payer_type: ['organization'] + * payer_type: ['org'] * ``` */ payer_type: string[]; From 027b0078068430527bb8c82729b84625ffff5de4 Mon Sep 17 00:00:00 2001 From: panteliselef Date: Mon, 7 Jul 2025 12:52:44 +0300 Subject: [PATCH 3/3] add changeset --- .changeset/bumpy-jobs-flow.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/bumpy-jobs-flow.md 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`.