Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 469
feat(clerk-js,localizations,shared,ui): Add support for credits#7776
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
136e9f3
feat(clerk-js,localizations,shared,ui): Add support for account credi…
dstaley 40ff41c
fix(clerk-js,localizations,shared,ui): Use new credits field
dstaley 02c4806
Merge branch 'main' into ds.feat/checkout-account-credit
dstaley 4f968e2
fix(clerk-js,shared,ui): Rename payerCredit to payer
dstaley 644618e
fix(clerk-js): Render proration credit from credits
dstaley f258cdb
test(react): Fix test data
dstaley 2d1ce73
test(ui): Add checkout credit test
dstaley 113dbcc
test(ui): Assert on specifc credit values
dstaley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| '@clerk/localizations': minor | ||
| '@clerk/clerk-js': minor | ||
| '@clerk/shared': minor | ||
| '@clerk/ui': minor | ||
| --- | ||
| Add support for account credits in checkout. | ||
336 changes: 336 additions & 0 deletions
336 packages/clerk-js/sandbox/scenarios/checkout-account-credit.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,336 @@ | ||
| import { | ||
| clerkHandlers, | ||
| http, | ||
| HttpResponse, | ||
| EnvironmentService, | ||
| SessionService, | ||
| setClerkState, | ||
| type MockScenario, | ||
| UserService, | ||
| } from '@clerk/msw'; | ||
| export function CheckoutAccountCredit(): MockScenario { | ||
| const user = UserService.create(); | ||
| const session = SessionService.create(user); | ||
| setClerkState({ | ||
| environment: EnvironmentService.MULTI_SESSION, | ||
| session, | ||
| user, | ||
| }); | ||
| const subscriptionHandler = http.get('https://*.clerk.accounts.dev/v1/me/billing/subscription', () => { | ||
| return HttpResponse.json({ | ||
| response: { | ||
| data: {}, | ||
| }, | ||
| }); | ||
| }); | ||
| const paymentMethodsHandler = http.get('https://*.clerk.accounts.dev/v1/me/billing/payment_methods', () => { | ||
| return HttpResponse.json({ | ||
| response: { | ||
| data: {}, | ||
| }, | ||
| }); | ||
| }); | ||
| const checkoutAccountCreditHandler = http.post('https://*.clerk.accounts.dev/v1/me/billing/checkouts', () => { | ||
| return HttpResponse.json({ | ||
| response: { | ||
| object: 'commerce_checkout', | ||
| id: 'string', | ||
| plan: { | ||
| object: 'commerce_plan', | ||
| id: 'string', | ||
| name: 'Pro', | ||
| fee: { | ||
| amount: 0, | ||
| amount_formatted: '25.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| annual_monthly_fee: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| annual_fee: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| description: null, | ||
| is_default: true, | ||
| is_recurring: true, | ||
| publicly_visible: true, | ||
| has_base_fee: true, | ||
| for_payer_type: 'string', | ||
| slug: 'string', | ||
| avatar_url: null, | ||
| free_trial_enabled: true, | ||
| free_trial_days: null, | ||
| features: [ | ||
| { | ||
| object: 'feature', | ||
| id: 'string', | ||
| name: 'string', | ||
| description: null, | ||
| slug: 'string', | ||
| avatar_url: null, | ||
| }, | ||
| ], | ||
| }, | ||
| plan_period: 'month', | ||
| payer: { | ||
| object: 'commerce_payer', | ||
| id: 'string', | ||
| instance_id: 'string', | ||
| user_id: null, | ||
| first_name: null, | ||
| last_name: null, | ||
| email: null, | ||
| organization_id: null, | ||
| organization_name: null, | ||
| image_url: 'https://example.com', | ||
| created_at: 1, | ||
| updated_at: 1, | ||
| }, | ||
| payment_method: { | ||
| object: 'commerce_payment_method', | ||
| id: 'string', | ||
| payer_id: 'string', | ||
| payment_type: 'card', | ||
| is_default: true, | ||
| gateway: 'string', | ||
| gateway_external_id: 'string', | ||
| gateway_external_account_id: null, | ||
| last4: null, | ||
| status: 'active', | ||
| wallet_type: null, | ||
| card_type: null, | ||
| expiry_year: null, | ||
| expiry_month: null, | ||
| created_at: 1, | ||
| updated_at: 1, | ||
| is_removable: true, | ||
| }, | ||
| external_gateway_id: 'string', | ||
| status: 'needs_confirmation', | ||
| totals: { | ||
| subtotal: { | ||
| amount: 1, | ||
| amount_formatted: '25.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| tax_total: { | ||
| amount: 1, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| grand_total: { | ||
| amount: 1, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| total_due_after_free_trial: { | ||
| amount: 1, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| total_due_now: { | ||
| amount: 1, | ||
| amount_formatted: '10.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| past_due: null, | ||
| credit: { | ||
| amount: 1, | ||
| amount_formatted: '5.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| credits: { | ||
| proration: { | ||
| amount: { | ||
| amount: 1, | ||
| amount_formatted: '5.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| cycle_days_remaining: 1, | ||
| cycle_days_total: 1, | ||
| cycle_remaining_percent: 1, | ||
| }, | ||
| payer: { | ||
| remaining_balance: { | ||
| amount: 1, | ||
| amount_formatted: '100.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| applied_amount: { | ||
| amount: 1, | ||
| amount_formatted: '10.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| }, | ||
| total: { | ||
| amount: 1, | ||
| amount_formatted: '15.00', | ||
| currency: 'string', | ||
| currency_symbol: '$', | ||
| }, | ||
| }, | ||
| }, | ||
| subscription_item: { | ||
| object: 'commerce_subscription_item', | ||
| id: 'string', | ||
| instance_id: 'string', | ||
| status: 'active', | ||
| credit: { | ||
| amount: { | ||
| amount: 1, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| cycle_days_remaining: 1, | ||
| cycle_days_total: 1, | ||
| cycle_remaining_percent: 1, | ||
| }, | ||
| plan_id: 'string', | ||
| price_id: 'string', | ||
| plan: { | ||
| object: 'commerce_plan', | ||
| id: 'string', | ||
| name: 'string', | ||
| fee: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| annual_monthly_fee: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| annual_fee: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| description: null, | ||
| is_default: true, | ||
| is_recurring: true, | ||
| publicly_visible: true, | ||
| has_base_fee: true, | ||
| for_payer_type: 'string', | ||
| slug: 'string', | ||
| avatar_url: null, | ||
| free_trial_enabled: true, | ||
| free_trial_days: null, | ||
| features: [ | ||
| { | ||
| object: 'feature', | ||
| id: 'string', | ||
| name: 'string', | ||
| description: null, | ||
| slug: 'string', | ||
| avatar_url: null, | ||
| }, | ||
| ], | ||
| }, | ||
| plan_period: 'month', | ||
| payment_method_id: 'string', | ||
| payment_method: { | ||
| object: 'commerce_payment_method', | ||
| id: 'string', | ||
| payer_id: 'string', | ||
| payment_type: 'card', | ||
| is_default: true, | ||
| gateway: 'string', | ||
| gateway_external_id: 'string', | ||
| gateway_external_account_id: null, | ||
| last4: null, | ||
| status: 'active', | ||
| wallet_type: null, | ||
| card_type: null, | ||
| expiry_year: null, | ||
| expiry_month: null, | ||
| created_at: 1, | ||
| updated_at: 1, | ||
| is_removable: true, | ||
| }, | ||
| lifetime_paid: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| amount: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| next_payment: { | ||
| amount: { | ||
| amount: 0, | ||
| amount_formatted: 'string', | ||
| currency: 'string', | ||
| currency_symbol: 'string', | ||
| }, | ||
| date: 1, | ||
| }, | ||
| payer_id: 'string', | ||
| payer: { | ||
| object: 'commerce_payer', | ||
| id: 'string', | ||
| instance_id: 'string', | ||
| user_id: null, | ||
| first_name: null, | ||
| last_name: null, | ||
| email: null, | ||
| organization_id: null, | ||
| organization_name: null, | ||
| image_url: 'https://example.com', | ||
| created_at: 1, | ||
| updated_at: 1, | ||
| }, | ||
| is_free_trial: true, | ||
| period_start: 1, | ||
| period_end: null, | ||
| proration_date: 'string', | ||
| canceled_at: null, | ||
| past_due_at: null, | ||
| ended_at: null, | ||
| created_at: 1, | ||
| updated_at: 1, | ||
| }, | ||
| plan_period_start: 1, | ||
| is_immediate_plan_change: true, | ||
| free_trial_ends_at: 1, | ||
| needs_payment_method: true, | ||
| }, | ||
| }); | ||
| }); | ||
| return { | ||
| description: 'Checkout with account credit', | ||
| handlers: [checkoutAccountCreditHandler, subscriptionHandler, paymentMethodsHandler, ...clerkHandlers], | ||
| initialState: { session, user }, | ||
| name: 'checkout-account-credit', | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| export { UserButtonSignedIn } from './user-button-signed-in'; | ||
| export { CheckoutAccountCredit } from './checkout-account-credit'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add tests covering account-credit checkout behavior.
No tests were added/updated for the new credits flow (parsing + UI display). Please add coverage to prevent regressions.
As per coding guidelines: "If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes."
🤖 Prompt for AI Agents