Skip to content
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

Feat plans docs #311

Merged
merged 26 commits into from
Dec 21, 2023
Merged

Feat plans docs #311

merged 26 commits into from
Dec 21, 2023

Conversation

gewenyu99
Copy link
Contributor

@gewenyu99 gewenyu99 commented Oct 31, 2023

What does this PR do?

Adds docs for plans in Appwrite under /docs/advanced/platform/plans

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

Copy link

vercel bot commented Oct 31, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 3 resolved Dec 21, 2023 0:53am

Copy link
Contributor

@heyCarla heyCarla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments/suggested copy. Otherwise looking good!

@lohanidamodar when you have a minute are you able to help me fill in the details about regions while Vincent is away?


You can compare each of the plans in the [pricing page](https://appwrite.io/pricing).

## Select a plan {% #selecting-a-plan %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we need this section. But if we do... we might say something along the lines of

If you already have an account with us, you can select a plan and start building straight from the pricing page. You can also create an organization in the Appwrite console and choose which plan you'd like to use from there.


[TODO]

## Billing periods {% #billing-periods %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All plans will have a billing period of 30 days from sign-up. If you have signed up for a Pro or Scale plan, your billing period will begin once the trial period ends. You can view your organization's current billing period in the Billing tab in the console.

# Resource limits {% #resource-limits %}
Each plan in Appwrite Cloud has a set of resource limits. You can find the details of these resource limits in the in the [pricing page](https://appwrite.io/pricing).

Each resource limit is applied per month and resets at the beginning of each month.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Each resource limit is applied per month and resets at the beginning of each month.
Each resource limit is applied per billing period and resets at the beginning of the next billing period, except for Storage usage, which is cumulative and will persist across all billing periods.

Copy link

render bot commented Nov 21, 2023

Copy link
Member

@lohanidamodar lohanidamodar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few comments

* Consequence
---
* **Bandwidth** {% rowspan=3 %}
* Project creation is disabled.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when bandwidth limit is reached, all API access will be disabled. But for pro/scale teams, nothing will be disabled rather additional charges will apply, until their budget cap is reached only then it will be disabled.

* If more than 1 database has been created, disable them in order of date created (oldest ones first).
---
* **Buckets**
* If more than 3 buckets have been created, disable them in order of date created (oldest ones first).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we disable the oldest ones or we disable the newest ones? for me it makes sense to disable the latest ones not the oldest ones

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lohanidamodar Depends on the behavior you implement. Let me know, I don't mind either way.

You can click the three-dots menu to view and download your invoices.

# Payment methods {% #payment-methods %}
Appwrite Cloud accepts credit card as payment methods and will bill the card at the end of each billing cycle.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

credit as well as debit card as of now. As far as I know stripe accepts both.

# Tax ID {% #tax-id %}
If you'd like you or your company's tax ID displayed on your generated invoice, you can provide it under **Tax ID**.

# Budget cap {% #budget-cap %}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also talk about billing alerts here in a separate section

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When do we send alerts and can they be configured?

I'll add a whole new section about all the alerts.

or create a new organization from the Appwrite Console and select the **Pro plan**.

## Trial {% #trial %}
Everh Appwrite Pro plan organization comes with a **14 day free trial**.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Everh Appwrite Pro plan organization comes with a **14 day free trial**.
Every Appwrite Pro plan organization comes with a **14 day free trial**.

# Resource limits {% #resource-limits %}
Each plan in Appwrite Cloud has a set of resource limits. You can find the details of these resource limits in the in the [pricing page](https://appwrite.io/pricing).

You can purchase additional resources when you go over the resource limits to continue scaling your app.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems odd, you can purchase, as until budget cap is reached, addons are auto applied ie. they don't need to purchase

You can access your organizations billing information under the **Billing** tab of your organization.

# Plans {% #plans %}
You can view or change your organization's plan under the **Plan summary** section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plan summary -> Billing suggestion

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@@ -0,0 +1,62 @@
## Check resource usage {% #check-resource-usage %}

You can check your organization's resource usage by navigating to the overview page of your organization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think there is overview page. There is projects, usage and billing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

* Consequence
---
* **Bandwidth** {% rowspan=3 %}
* More bandwidth will be purchased automatically until organization reaches budget cap. If the organization uses a Starter plan or budget cap is reached, API access will be disabled until more bandwidth is purchased.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

disabled, I would do blocked or denied

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

* Consequence
---
* **Bandwidth** {% rowspan=3 %}
* More bandwidth will be purchased automatically until organization reaches budget cap. If the organization uses a Starter plan or budget cap is reached, API access will be disabled until more bandwidth is purchased.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For free it makes sense you until more bandwidth is purchased, but for when you are pro already, solution is to increase budget cap.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Copy link
Contributor

@heyCarla heyCarla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple small things!

src/partials/resource-limits.md Outdated Show resolved Hide resolved
src/partials/resource-limits.md Outdated Show resolved Hide resolved
---
* Platform creation disabled.
---
* **Monthly active users**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For billing v1 I don't think we can use the term Monthly active users. It should be "Users" here. Is that correct @lohanidamodar @ArmanNik ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@heyCarla that's correct

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to push this change? Looks the same to me

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, imagine pushing after making changes. Thanks

src/partials/resource-limits.md Outdated Show resolved Hide resolved
src/routes/docs/advanced/platform/billing/+page.markdoc Outdated Show resolved Hide resolved
Vincent (Wen Yu) Ge and others added 4 commits December 18, 2023 12:00
Co-authored-by: Carla <cg.alexander@gmail.com>
Co-authored-by: Carla <cg.alexander@gmail.com>
Co-authored-by: Carla <cg.alexander@gmail.com>
Co-authored-by: Carla <cg.alexander@gmail.com>
@eldadfux eldadfux merged commit 98bee9d into main Dec 21, 2023
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants