Files
supabase/apps/docs/content/guides/platform/credits.mdx
Miranda Limonczenko 7ce4ee53ae chore(docs) Retire supa-mdx-lint (#50602)
Closes
[DOCS-1289](https://linear.app/supabase/issue/DOCS-1289/get-the-linter-to-fix-what-it-flags-or-retirereplace-the-linter)

Stacked on #50600, which points contributors at the authoring skills.
Merge that one first.

## Problem

Contributors experienced friction with the linter. They felt nickle and
dimed for tiny nits and felt detracted from the work itself. PRs would
become noisy with tiny one-word suggestions.

Additionally, our homegrown linter is not very intelligent, causing
frequent overrides.

## Solution

This removes the linter entirely in favor of directing contributors to
use SKILLS instead.

The removal entails...

- **CI.** Delete the three `docs_lint` workflows: the PR check, the
external-PR comment companion, and the nightly `--fix` bot. Drop the
stale `zizmor.yml` ignore entry for the deleted workflow.
- **Tooling.** Delete `supa-mdx-lint.config.toml` and the 14 rule files.
Drop the `lint:mdx` script and the `@supabase/supa-mdx-lint` dependency
from docs, learn, and ui-library, and regenerate the lockfile.
- **Content.** Remove the 181 directives. A separate commit carries
Prettier's reformatting of the tables and blank lines those comments had
suppressed, so the deletion commit stays readable. No prose changes.
- **Style guide.** The word list states each rule directly instead of
describing what the linter flagged. Every term survives, including the
phrase groups that mirrored `Rule004ExcludeWords`.
- **Skills.** `write-the-docs`, `edit-the-docs`, and `review-the-docs`
drop `pnpm lint:mdx` from their self-review commands and check the word
list directly. `ask-the-docs`'s CI reference drops both workflows.

## Manual testing

1. Run `git grep -i supa-mdx-lint -- . ':!pnpm-lock.yaml'`. No matches.
2. Run `pnpm install --frozen-lockfile --lockfile-only`. It passes, so
the lockfile matches the three trimmed manifests.
3. Run `git diff master...HEAD --name-only --diff-filter=ACMR | grep -E
'\.(md|mdx)$' | xargs npx prettier --config prettier.config.mjs
--check`. All changed markdown passes.
4. Open the [reformatted filter
table](https://docs-git-docs-retire-mdx-linter-supabase.vercel.app/docs/guides/observability/logs#filter-events)
on the preview and compare it with
[production](https://supabase.com/docs/guides/observability/logs#filter-events).
The table renders the same.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Documentation guidance now uses manual prose and terminology review
with the shared word list.
* Clarified storage configuration and common Realtime channel mistakes.
* Improved table formatting, text wrapping, and selected reference
links.
  * Updated documentation authoring and review guidance.

* **Chores**
* Retired automated MDX linting from workflows and local validation
commands.
* Removed lint-suppression markers throughout documentation without
changing instructions.
  * Added targeted documentation review guidance for pull requests.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-09-22 10:00:41 -07:00

79 lines
3.0 KiB
Plaintext

---
id: 'credits'
title: 'Credits'
---
## Credit balance
Each organization has a credit balance. Credits are applied to future invoices to reduce the amount due. As long as the credit balance is greater than <Price price="0" />, credits will be used before charging your payment method on file.
<Image
alt="Subscription upgrade modal"
src={{
light: '/docs/img/guides/platform/credit-balance--light.png',
dark: '/docs/img/guides/platform/credit-balance--dark.png',
}}
width={2034}
height={388}
/>
You can find the credit balance on the [organization's billing page](/dashboard/org/_/billing).
### What causes the credit balance to change?
**Subscription plan downgrades:** Upon subscription downgrade, any prepaid subscription fee will be credited back to your organization for unused time in the billing cycle.\
As an example, if you start a Pro Plan subscription on January 1 and downgrade to the Free Plan on January 15, your organization will receive about 50% of the subscription fee as credits for the unused time between January 15 and January 31.
**Credit top-ups:** You self-served a credit top-up or have signed an upfront credits deal with our growth team.
## Credit top-ups
You can top up credits at any time, with a maximum of <Price price="2000" /> per top-up. These credits do not expire and are non-refundable. Credits are granted on the pre-tax amount. Any applicable taxes added at checkout are not credited.
You may want to consider this option to avoid issues with recurring payments, gain more control over how often your credit card is charged, and potentially make things easier for your accounting department.
<Admonition type="note">
If you are interested in larger (> <Price price="2000" />) credit packages, [reach out](/dashboard/support/new?subject=I%20would%20like%20to%20inquire%20about%20larger%20credit%20packages&category=Sales).
</Admonition>
### How to top up credits
1. On the [organization's billing page](/dashboard/org/_/billing), go to section **Credit Balance**
2. Click **Top Up**
3. Choose the amount
4. Choose a payment method or add a new payment method
5. Click **Top Up**
<Image
alt="Subscription upgrade modal"
src={{
light: '/docs/img/guides/platform/credit-top-up--light.png',
dark: '/docs/img/guides/platform/credit-top-up--dark.png',
}}
className="max-w-[500px]"
width={1014}
height={758}
/>
## Credit FAQ
### Will I get an invoice for the credits purchase?
Yes, once the payment is confirmed, you will get a matching invoice that can be accessed through your [organization's invoices page](/dashboard/org/_/billing#invoices).
### Can I use a credit top-up to pay an outstanding invoice?
Credit top-ups apply only to future invoices. They cannot be used to pay or adjust outstanding invoices.
### Can I transfer credits to another organization?
Yes, you can transfer credits to another organization. Submit a [support ticket](https://supabase.help).
### Can I get a refund of my unused credits?
No, we do not provide refunds. Please refer to our [Terms of Service](/terms#1-fees).