diff --git a/www/apps/cloud/app/billing/manage/page.mdx b/www/apps/cloud/app/billing/manage/page.mdx index 24224a7ab0..0d762ecdcc 100644 --- a/www/apps/cloud/app/billing/manage/page.mdx +++ b/www/apps/cloud/app/billing/manage/page.mdx @@ -98,3 +98,26 @@ To change the default payment method: 7. Choose "Set as default" from the dropdown. The next time Cloud captures the subscription payment for your organization, it will use this payment method first. + +--- + +## Change Concurrent Previews Limit + +Based on your [plan](../../pricing/page.mdx), you may have limits on the number of active preview environments you can have at a time. For example, if your plan allows for one active preview environment, you can only have one open PR with a preview environment at a time. + +You can increase the concurrent previews limit, which would add it to your bill as an [add-on resource](../page.mdx#purchase-add-on-resources). + +To change the concurrent previews limit: + +1. Make sure you're viewing the [correct organization's dashboard in Cloud](../../organizations/page.mdx#switch-organization). +2. Click on the icon in the [organization switcher](../../organizations/page.mdx#switch-organization) at the top left of the Cloud dashboard. +3. Choose "Organization Settings" from the dropdown. +4. Change to the "Billing" settings from the sidebar. +5. In the "Concurrent previews" section, enter the number of concurrent previews you want to have. + - You can't enter a number lower than your current active preview environments. For example, if you have two active preview environments, you can't set the limit to one. + - You can see how much it would cost to increase the limit below the input field. +6. Once you're done, click the "Save changes" button. + +This will apply the new limit to your organization, and you can view your updated bill in the [Invoices](../page.mdx#view-billing-history-and-invoices) settings. + +![Concurrent previews section in the Billing settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1759410004/Cloud/CleanShot_2025-10-02_at_15.59.33_2x_rutivf.png) \ No newline at end of file diff --git a/www/apps/cloud/app/billing/page.mdx b/www/apps/cloud/app/billing/page.mdx index 790886d2ec..5a57505f94 100644 --- a/www/apps/cloud/app/billing/page.mdx +++ b/www/apps/cloud/app/billing/page.mdx @@ -51,12 +51,30 @@ You can also see a table with all the payments made for your organization, inclu ### Download Invoice -To download an invoice for a specific payment, click the icon in the same row as the payment you want to download. +An invoice is generated for every successful payment made for your organization. You can download the invoice as a PDF for your records. An invoice shows a request to pay for your organization's plan and any add-ons or flex usage charges. + +To download an invoice for a specific payment: + +1. Click the icon at the end of the row for the payment you want to download the invoice for. +2. Choose "Download invoice" from the dropdown. This will open the invoice in a new tab, where you can view and download it as a PDF. ![Download invoice icon in the Invoices settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1750242445/Cloud/CleanShot_2025-06-18_at_13.27.05_2x_qqibor.png) +### Download Receipt + +A receipt is generated for every successful payment made for your organization. You can download the receipt as a PDF for your records. A receipt shows proof of payment for your organization's plan and any add-ons or flex usage charges. + +To download a receipt for a specific payment: + +1. Click the icon at the end of the row for the payment you want to download the receipt for. +2. Choose "Download receipt" from the dropdown. + +This will open the receipt in a new tab, where you can view and download it as a PDF. + +![Download receipt icon in the Invoices settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1750242600/Cloud/CleanShot_2025-06-18_at_13.30.03_2x_wwm3yo.png) + --- ## Purchase Add-On Resources @@ -105,6 +123,9 @@ To change your organization's plan: 3. Choose "Organization Settings" from the dropdown. 4. Change to the "Billing" settings from the sidebar. 5. In the "Upcoming payment" section, click the "Change plan" button. + +![Change plan button in the Billing settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1759415060/Cloud/CleanShot_2025-10-02_at_17.23.41_2x_dtqz5r.png) + 6. In the modal that opens, choose either to upgrade to the Pro plan or downgrade to the Hobby plan. - To upgrade to the Enterprise plan, contact support for assistance. 7. Confirm the plan change in the pop-up by clicking the "Confirm" button. @@ -135,3 +156,5 @@ To cancel your organization's plan: 4. Change to the "Billing" settings from the sidebar. 5. Scroll down to the "Cancel plan" section and click the "Cancel plan" button. 6. Confirm the cancellation in the pop-up by clicking the "Confirm" button. + +![Cancel plan section in the Billing settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1759415806/Cloud/CleanShot_2025-10-02_at_17.30.39_2x_d8ixwc.png) \ No newline at end of file diff --git a/www/apps/cloud/app/deployments/page.mdx b/www/apps/cloud/app/deployments/page.mdx index aa7d485e64..19b5dcf432 100644 --- a/www/apps/cloud/app/deployments/page.mdx +++ b/www/apps/cloud/app/deployments/page.mdx @@ -82,10 +82,10 @@ On the deployment details page, you'll find: ![Deployment details page with key sections highlighted](https://res.cloudinary.com/dza7lstvk/image/upload/v1750147821/Cloud/CleanShot_2025-06-17_at_11.08.58_2x_ea1l8s.png) -1. **Commit**: The commit that the deployment was created from. -2. **Status**: The current [status](#deployment-statuses-and-lifecycle) of the deployment. For example, "Live" or "Build Failed". -3. **Author**: The GitHub user who pushed the commit that created the deployment. -4. **Build Logs**: The logs from the build process. They are useful to understand why a deployment failed. Learn more in the [Logs](../logs/page.mdx) guide. +1. **Commit**: The commit that the deployment was created from. This is the page's title. +2. **Status**: The current [status](#deployment-statuses-and-lifecycle) of the deployment. For example, "Live" or "Build Failed". You can see it next to the "Redeploy" button. +3. **Author**: The GitHub user who pushed the commit that created the deployment. You can see the user name when you hover over the user's avatar. +4. **Build Logs**: This section shows the logs from the build process. They are useful to understand why a deployment failed. Learn more in the [Logs](../logs/page.mdx) guide. ### Switch Between Deployments @@ -301,7 +301,7 @@ For each environment, you can change the rules that trigger a new deployment. Fo -Changing the branch associted with an environment only works for long-lived environments. +Changing the branch associated with an environment only works for [long-lived environments](../environments/long-lived/page.mdx). @@ -309,11 +309,11 @@ To change the deployment rules for an environment: 1. [Go to the environment's dashboard](#find-environment-deployments). 2. Click on the "Settings" tab. -3. Scroll down to the "Deployment rules" section. You'll find a `branch` rule in this section. +3. Click on the "Deployment rules" tab in the sidebar. +4. You'll find a `branch` rule. You can edit it by clicking the icon and choosing "Edit" from the dropdown. ![Deployment rules section in the environment's settings tab](https://res.cloudinary.com/dza7lstvk/image/upload/v1750171235/Cloud/CleanShot_2025-06-17_at_17.40.13_2x_v0vn1k.png) -4. You can edit it by clicking the icon and choosing "Edit" from the dropdown. 5. In the side window that opens, you can change the branch that the environment is connected to. For example, you can change it from `main` to `staging` to create a new deployment every time you push a commit to the `staging` branch. 6. Click "Save" to apply the changes. diff --git a/www/apps/cloud/app/environments/long-lived/page.mdx b/www/apps/cloud/app/environments/long-lived/page.mdx index 9bd5a0e49c..1a25ac160b 100644 --- a/www/apps/cloud/app/environments/long-lived/page.mdx +++ b/www/apps/cloud/app/environments/long-lived/page.mdx @@ -72,8 +72,6 @@ After creating the environment, Medusa will automatically trigger a deployment f After that, Medusa will automatically deploy the environment whenever you push a new commit to the associated branch. -![Project dashboard showing the created environment](https://res.cloudinary.com/dza7lstvk/image/upload/v1749813096/Cloud/CleanShot_2025-06-13_at_14.11.09_2x_j6uoap.png) - ### Create Medusa Admin User in Environment After the environment is deployed, you need to set the email and password for the environment's Medusa Admin user. diff --git a/www/apps/cloud/app/environments/preview/page.mdx b/www/apps/cloud/app/environments/preview/page.mdx index 912d742680..5c76ecc99d 100644 --- a/www/apps/cloud/app/environments/preview/page.mdx +++ b/www/apps/cloud/app/environments/preview/page.mdx @@ -49,6 +49,25 @@ You can also view the preview deployment and its status in the comment made on y --- +## Increase Preview Environment Limits + +Based on your [plan](../../pricing/page.mdx), you may have limits on the number of active preview environments you can have at a time. For example, if your plan allows for one active preview environment, you can only have one open PR with a preview environment at a time. + +You can increase this limit either from the [Billing](../../billing/manage/page.mdx#change-concurrent-previews-limit) settings or on the project dashboard. + +To increase the concurrent previews limit from the project dashboard: + +1. Go to the [project's dashboard](../../projects/page.mdx#open-project-dashboard). +2. In the "Previews" card, click the "Provision" button. +3. In the pop-up that opens, you can see how much it would cost to increase the limit. +4. Click the "Increase limit and deploy preview" button to confirm. + +This will increase the concurrent previews limit for your organization, and you can view your updated bill in the [Invoices](../../billing/page.mdx#view-billing-history-and-invoices) settings. + +![Provision preview environments pop-up in the project dashboard](https://res.cloudinary.com/dza7lstvk/image/upload/v1759410384/Cloud/CleanShot_2025-10-02_at_16.04.33_2x_z5zpw6.png) + +--- + ## Access Deployed Preview Environment Once the preview environment has finished deploying, you can access its Medusa Admin either through the comment in the PR or by clicking the "Preview" button in the [project's dashboard](../../projects/page.mdx#open-project-dashboard). diff --git a/www/apps/cloud/app/organizations/page.mdx b/www/apps/cloud/app/organizations/page.mdx index fa4612fd62..5c2593bd48 100644 --- a/www/apps/cloud/app/organizations/page.mdx +++ b/www/apps/cloud/app/organizations/page.mdx @@ -77,7 +77,7 @@ This will open a new window where you can view and manage an organization's sett To edit an organization's general details: 1. [Open the organization's settings](#view-organization-settings). -2. In the General tab, you can edit the organization's name and billing email address. +2. In the General tab, you can edit the organization's name, billing email address, and Tax ID. 3. Once you're done making changes, click the "Save changes" button in the Details section. ![Window showing the organization settings with the General tab selected and the Details section highlighted](https://res.cloudinary.com/dza7lstvk/image/upload/v1749733691/Cloud/CleanShot_2025-06-12_at_16.07.52_2x_uaabq2.png) @@ -151,8 +151,7 @@ To invite members to your organization: 1. [Open the organization's settings](#view-organization-settings). 2. Click on the "Team" tab. -3. In the "Invite members" section, enter the email address of the user you want to invite, then click the button. You can enter multiple email addresses. -4. Once you're done, click the "Invite all" button. +3. In the "Invite members" section, enter the email addresses of the users you want to invite. You can enter multiple email addresses separated by commas. These users will receive an email invitation to join your organization. They can accept the invitation by clicking the link in the email. @@ -208,7 +207,8 @@ To edit your profile's details: 1. Click on your name and avatar at the top right of the Cloud dashboard. 2. Choose "Settings" from the dropdown. -3. In the Profile Settings page, you can edit your name, email address, and your membership in organizations. +3. This will open the Profile settings tab in the Organization Settings. You can edit your first and last name and email address. +4. Once you're done making changes, click the "Update profile" button. ![Window showing the profile settings with the Profile tab selected](https://res.cloudinary.com/dza7lstvk/image/upload/v1749735037/Cloud/CleanShot_2025-06-12_at_16.30.12_2x_bxz00e.png) diff --git a/www/apps/cloud/app/projects/page.mdx b/www/apps/cloud/app/projects/page.mdx index 311f64f405..1577804ace 100644 --- a/www/apps/cloud/app/projects/page.mdx +++ b/www/apps/cloud/app/projects/page.mdx @@ -47,7 +47,7 @@ Medusa provides you with the following starters that you can use to quickly set To create a project from either of these starters: -1. Click on the **Browse Starters** button at the top right. +1. Click on the **Browse Starters** button at the top right of the [project creation page](#create-a-project). 2. Click the **Clone** button of the starter you want to use. 3. In the Repository step, authenticate with your GitHub account if you haven't already. 4. Choose a GitHub organization to clone the starter into in the "Organization" field. @@ -82,7 +82,7 @@ So, make sure to remove any of these modules from your `medusa-config.ts` file, To create a project from an existing Medusa application: -1. In the GitHub section, authenticate with your GitHub account if you haven't already. +1. In the GitHub section of the [project-creation page](#create-a-project), authenticate with your GitHub account if you haven't already. 2. Under the Repository section, choose the repository to create the project from. - If you don't see your repository, you can click the **Configure repositories** link to manage the GitHub repositories that Medusa can access. 3. Once you're done, click the **Continue** button. @@ -140,6 +140,8 @@ If you encounter any issues while creating a project: ## Subdomain Restrictions for Projects +Your project's URL must be a subdomain of `medusajs.app`. For example, if you choose `my-store` as your subdomain, your project's URL will be `my-store.medusajs.app`. + When you choose a subdomain for your project, it must be at least five characters long. It also can't be one of the following reserved subdomains: - `medusa` @@ -187,15 +189,16 @@ When you open a project's dashboard, its name will be shown at the top left next On the project's dashboard, you can view the following details: -![The project dashboard with the details of a project](https://res.cloudinary.com/dza7lstvk/image/upload/v1749743078/Cloud/CleanShot_2025-06-12_at_18.42.54_2x_rin0pw.png) +![The project dashboard with the details of a project](https://res.cloudinary.com/dza7lstvk/image/upload/v1759405506/Cloud/CleanShot_2025-10-02_at_14.42.33_2x_w4ql3x.png) 1. **Region**: The region where the project is deployed. You'll find it below the project name. 2. **Environments**: The environments for the project are shown as cards. By default, you'll find Production and Previews environments. You can learn more about environments in the [Environments](../environments/page.mdx) guide. - The Production environment is the live environment where your Medusa application is deployed and clients connect to. - The Previews environments are created whenever you create a pull request in the linked GitHub repository. They allow you to preview changes before merging them into the main branch. + - Other [Long-lived environments](../environments/long-lived/page.mdx) like Staging will be shown here if you create them. 3. **Production URL**: The URL of the project's production deployment. You'll find it in the "Production" card under the title. Clicking it will open the production Medusa Admin in a new tab. 4. **Repository**: The GitHub repository linked to the project. You'll find it as a "Repository" button at the top right of the project's dashboard. Clicking it will open the repository in a new tab. -5. **Production Status**: The status of the project's environment, which may be "Live" or "Building". Learn more in the [Deployments](../deployments/page.mdx#deployment-statuses-and-lifecycle) guide. +5. **Production Deployment Status**: The deployment status of the project's environment, which may be "Live" or "Building". Learn more in the [Deployments](../deployments/page.mdx#deployment-statuses-and-lifecycle) guide. ### Switch Projects diff --git a/www/apps/cloud/generated/edit-dates.mjs b/www/apps/cloud/generated/edit-dates.mjs index 1e8871a4b5..9dca11b72a 100644 --- a/www/apps/cloud/generated/edit-dates.mjs +++ b/www/apps/cloud/generated/edit-dates.mjs @@ -1,10 +1,10 @@ export const generatedEditDates = { "app/page.mdx": "2025-09-11T15:21:38.987Z", "app/organization/page.mdx": "2025-06-12T14:43:20.772Z", - "app/projects/page.mdx": "2025-09-29T12:03:35.689Z", + "app/projects/page.mdx": "2025-10-02T11:49:21.541Z", "app/environments/page.mdx": "2025-06-25T08:00:05.550Z", - "app/deployments/page.mdx": "2025-06-25T07:57:13.059Z", - "app/organizations/page.mdx": "2025-09-11T15:21:38.987Z", + "app/deployments/page.mdx": "2025-10-02T13:45:55.265Z", + "app/organizations/page.mdx": "2025-10-02T11:31:07.315Z", "app/notifications/page.mdx": "2025-06-25T07:27:37.642Z", "app/database/page.mdx": "2025-08-15T15:30:37.814Z", "app/redis/page.mdx": "2025-06-25T07:57:23.246Z", @@ -14,12 +14,12 @@ export const generatedEditDates = { "app/update-medusa/page.mdx": "2025-06-25T07:57:30.170Z", "app/connect-storefront/page.mdx": "2025-06-25T07:47:00.499Z", "app/environments/environment-variables/page.mdx": "2025-08-15T15:35:24.085Z", - "app/environments/long-lived/page.mdx": "2025-08-25T07:23:59.858Z", - "app/environments/preview/page.mdx": "2025-08-20T12:15:33.952Z", + "app/environments/long-lived/page.mdx": "2025-10-02T11:58:36.623Z", + "app/environments/preview/page.mdx": "2025-10-02T13:06:32.356Z", "app/faq/page.mdx": "2025-09-11T14:26:01.400Z", - "app/billing/page.mdx": "2025-09-04T15:25:50.586Z", + "app/billing/page.mdx": "2025-10-02T14:37:27.199Z", "app/usage/page.mdx": "2025-08-25T07:25:54.703Z", - "app/billing/manage/page.mdx": "2025-09-04T14:50:46.747Z", + "app/billing/manage/page.mdx": "2025-10-02T13:08:08.552Z", "app/pricing/page.mdx": "2025-09-05T10:31:59.059Z", "app/sign-up/page.mdx": "2025-09-29T10:16:20.885Z", "app/comparison/page.mdx": "2025-09-30T06:17:40.257Z"