chore(clerk-js): Use /subscription_items endpoint to cancel subs
#6341
Conversation
🦋 Changeset detectedLatest commit: a2397d2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe changes update the API endpoint used for cancelling subscriptions in the codebase. Specifically, the cancellation logic now sends DELETE requests to the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.changeset/spicy-shirts-kiss.md(1 hunks)packages/clerk-js/src/core/resources/CommerceSubscription.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{js,jsx,ts,tsx}
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/development.mdc
packages/**/*.ts
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/development.mdc
packages/**/*.{ts,tsx,d.ts}
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/development.mdc
**/*.{ts,tsx}
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/development.mdc
- .cursor/rules/typescript.mdc
packages/{clerk-js,elements,themes}/**/*
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/monorepo.mdc
**/*
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🧠 Learnings (3)
📓 Common learnings
Learnt from: dstaley
PR: clerk/javascript#6116
File: .changeset/tangy-garlics-say.md:1-2
Timestamp: 2025-06-13T16:09:53.061Z
Learning: In the Clerk JavaScript repository, contributors create intentionally empty changeset files (containing only the YAML delimiters) when a PR touches only non-published parts of the codebase (e.g., sandbox assets). This signals that no package release is required, so such changesets should not be flagged as missing content.
Learnt from: panteliselef
PR: clerk/javascript#6327
File: .changeset/eight-socks-lead.md:2-4
Timestamp: 2025-07-16T10:43:17.706Z
Learning: In the Clerk JavaScript repository, APIs marked with @experimental JSDoc annotations can have breaking changes released with minor version bumps rather than major version bumps, as consumers are warned about the instability of experimental features. The billing feature specifically has an @experimental annotation stating "This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change."
Learnt from: wobsoriano
PR: clerk/javascript#6099
File: packages/backend/src/api/endpoints/IdPOAuthAccessTokenApi.ts:7-14
Timestamp: 2025-06-10T20:38:08.982Z
Learning: Methods in `packages/backend/src/api/endpoints` (e.g., `IdPOAuthAccessTokenApi.verifySecret`) are currently not exposed publicly, so renaming them does not constitute a breaking change.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Update documentation for API changes
Learnt from: wobsoriano
PR: clerk/javascript#6163
File: packages/backend/src/api/endpoints/APIKeysApi.ts:60-70
Timestamp: 2025-06-20T17:44:17.570Z
Learning: The Clerk codebase uses POST method for API key update operations instead of the typical PATCH method, as clarified by the maintainer wobsoriano.
.changeset/spicy-shirts-kiss.md (4)
Learnt from: wobsoriano
PR: clerk/javascript#6163
File: packages/backend/src/api/endpoints/APIKeysApi.ts:60-70
Timestamp: 2025-06-20T17:44:17.570Z
Learning: The Clerk codebase uses POST method for API key update operations instead of the typical PATCH method, as clarified by the maintainer wobsoriano.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-30T10:29:42.997Z
Learning: Update documentation for API changes
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.{jsx,tsx} : Implement proper subscription cleanup
Learnt from: panteliselef
PR: clerk/javascript#6285
File: packages/types/src/commerce.ts:1305-1305
Timestamp: 2025-07-11T18:08:14.697Z
Learning: In the Clerk JavaScript repository, when there's a conflict between naming consistency (camelCase) and avoiding breaking changes, the team prioritizes maintaining backward compatibility over enforcing naming conventions, even for experimental APIs.
packages/clerk-js/src/core/resources/CommerceSubscription.ts (3)
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/react.mdc:0-0
Timestamp: 2025-06-30T10:32:37.848Z
Learning: Applies to **/*.{jsx,tsx} : Implement proper subscription cleanup
Learnt from: wobsoriano
PR: clerk/javascript#6099
File: packages/backend/src/api/endpoints/IdPOAuthAccessTokenApi.ts:7-14
Timestamp: 2025-06-10T20:38:08.982Z
Learning: Methods in `packages/backend/src/api/endpoints` (e.g., `IdPOAuthAccessTokenApi.verifySecret`) are currently not exposed publicly, so renaming them does not constitute a breaking change.
Learnt from: panteliselef
PR: clerk/javascript#6327
File: .changeset/eight-socks-lead.md:2-4
Timestamp: 2025-07-16T10:43:17.706Z
Learning: In the Clerk JavaScript repository, APIs marked with @experimental JSDoc annotations can have breaking changes released with minor version bumps rather than major version bumps, as consumers are warned about the instability of experimental features. The billing feature specifically has an @experimental annotation stating "This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change."
🔇 Additional comments (1)
.changeset/spicy-shirts-kiss.md (1)
1-6: Changeset documentation looks good.The changeset properly documents the endpoint change with an appropriate patch-level version bump. The description accurately reflects the internal implementation change from
/subscriptionsto/subscription_itemsfor subscription cancellation.
| ? `/organizations/${orgId}/commerce/subscription_items/${this.id}` | ||
| : `/me/commerce/subscription_items/${this.id}`, |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify the new endpoint exists and functions correctly.
The endpoint change from /commerce/subscriptions/{id} to /commerce/subscription_items/{id} looks correct for cancelling subscription items. However, ensure that the new endpoint is properly implemented on the backend and handles the same authentication and authorization logic.
🏁 Script executed:
#!/bin/bash
# Description: Verify usage of the new subscription_items endpoint across the codebase
# Expected: Find references to the new endpoint and confirm no remaining old endpoint usage
echo "=== Searching for new subscription_items endpoint usage ==="
rg -A 3 -B 3 "subscription_items" --type ts --type js
echo "=== Searching for potential remaining old subscriptions endpoint usage ==="
rg -A 3 -B 3 "/commerce/subscriptions/" --type ts --type js
echo "=== Searching for tests that might need updating ==="
rg -A 5 -B 5 "CommerceSubscription.*cancel" --type ts --type jsLength of output: 1362
Ensure Test Coverage for CommerceSubscription.cancel
All instances of the old /commerce/subscriptions/{id} endpoint have been replaced with /commerce/subscription_items/{id}, and no remaining references to the old path were found. However, it looks like there are no existing unit tests covering the cancel method in CommerceSubscription. Please add or update tests to validate both user- and organization-scoped cancellation:
• File needing coverage:
packages/clerk-js/src/core/resources/CommerceSubscription.ts (lines 71–72)
• /organizations/${orgId}/commerce/subscription_items/${this.id}
• /me/commerce/subscription_items/${this.id}
• Suggested tests:
– Mock the HTTP client and verify the correct path is used for org and user calls
– Assert that a DELETE request to each endpoint returns the expected DeletedObjectJSON
– Cover error and edge cases (e.g., missing orgId)
🤖 Prompt for AI Agents
In packages/clerk-js/src/core/resources/CommerceSubscription.ts around lines 71
to 72, add unit tests for the cancel method to ensure coverage of both
organization- and user-scoped cancellation. Mock the HTTP client to verify that
the correct DELETE request is sent to
`/organizations/${orgId}/commerce/subscription_items/${this.id}` when orgId is
present and to `/me/commerce/subscription_items/${this.id}` when it is not.
Include assertions that the response matches the expected DeletedObjectJSON and
add tests for error scenarios such as missing orgId.
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit