@lunch-money/developer-docs 2.11.0 → 2.11.1-docs.2

package/docs/README.md

@@ -5,6 +5,7 @@ This directory contains documentation that applies across all API versions.
 ## Current Documents
 
 - `pagination.md` - Pagination guidelines
+- `branding-your-app.md` - Brand assets and usage guidelines for apps built on Lunch Money
 - (To be added) Other version-independent documentation
 
 ## Version-Specific Documentation

package/docs/STYLE_GUIDE.md

@@ -0,0 +1,88 @@
+# Documentation style guide
+
+Use this guide for hand-written Markdown in `docs/` and `v2/docs/`. Preserve
+intentional conventions in generated pages, the v1 Slate reference, and version
+history entries.
+
+## Voice and structure
+
+- Address the reader as “you” and use direct, practical language.
+- Start with the reader's goal before introducing protocol or API details.
+- Use one H1 per page and keep heading levels in logical order.
+- Use sentence case for prose headings. Preserve official names, initialisms,
+  endpoint paths, property names, and exact UI labels.
+- Add a next step when a guide belongs to a longer reader journey. Use
+  `## Need help?` only when the page provides support options.
+
+## Terminology
+
+- Use “Lunch Money” for the product and “Lunchbag Labs, Inc.” only when the
+  legal company name is required.
+- Use “Developer Portal,” “Developers page,” and “API reference” consistently.
+  Preserve different capitalization only for an exact UI label.
+- Use “budget account” for the Lunch Money data container that holds a budget,
+  transactions, categories, and financial accounts. Use “account” only when the
+  context is unambiguous, and preserve exact UI labels such as “Create a New
+  Budget Account.”
+- Write “v1” and “v2” in prose. Use “V2 API” only where it is an established
+  proper label, such as the rendered reference title.
+- Distinguish authentication from authorization, personal access tokens from
+  OAuth access tokens, and applications from their registered OAuth clients.
+
+## Code and placeholders
+
+- Format endpoints, properties, headers, status codes, commands, filenames,
+  scope names, and literal values as code.
+- Use `YOUR_ACCESS_TOKEN` as the generic access-token placeholder. Environment
+  variable examples may use `LUNCH_MONEY_ACCESS_TOKEN`.
+- For equivalent multi-language examples, order tabs as JavaScript/Node.js,
+  Python, then cURL. Comparison tabs may follow the order that best teaches the
+  difference.
+- Keep examples fictional and never include or request real credentials.
+
+## Callouts
+
+Use the supported blockquote form:
+
+```markdown
+> [!NOTE] Optional title
+> Supporting content.
+```
+
+- Use `NOTE` for context that affects understanding.
+- Use `TIP` for optional advice or a more effective workflow.
+- Use `WARNING` for credible security, privacy, data-loss, breaking-change, or
+  operational risk.
+- Use sentence case for optional callout titles. Do not use HTML line breaks to
+  separate callout paragraphs.
+
+## Tabs
+
+Use tabs when equivalent examples in multiple languages or a focused comparison
+are easier to understand together:
+
+```markdown
+:::tabs
+@tab JavaScript/Node.js
+JavaScript example
+
+@tab Python
+Python example
+:::
+```
+
+Use an `@tab` label for each panel and close the container with `:::`. For
+equivalent language examples, order tabs as JavaScript/Node.js, Python, then
+cURL. Comparison tabs may use the order that best teaches the difference.
+
+## Links and presentation
+
+- Use canonical documentation paths from `manifest.json`. Keep aliases only for
+  compatibility; do not introduce new links to aliases.
+- Use normal Markdown links for internal navigation. Keep HTML only when it adds
+  behavior Markdown cannot express, such as opening an external link in a new
+  tab.
+- Avoid deeply nested headings, very wide tables, and long unbroken text that is
+  difficult to use in the constrained content column.
+- Remove trailing whitespace and use blank lines, not `<br>`, for Markdown
+  structure unless a verified rendering requirement needs HTML.

package/docs/amounts-and-balances.md

@@ -1,4 +1,4 @@
-# Amounts & Balances
+# Amounts & balances
 
 The Lunch Money API uses four properties — `amount`, `balance`, `currency`, and `to_base` — consistently across all objects that deal with money. Understanding how they work will help you build accurate, multi-currency-aware integrations.
 
@@ -24,7 +24,7 @@ Like `amount`, `balance` is always in the `currency` of the same object and foll
 
 ## `currency`
 
-`currency` is an ISO 4217 currency code (e.g., `"usd"`, `"eur"`, `"gbp"`). It is present on every object that carries an `amount` or `balance` and tells you what currency those values are in. See the [Supported Currencies guide](/v2/currencies) for the full list.
+`currency` is an ISO 4217 currency code (e.g., `"usd"`, `"eur"`, `"gbp"`). It is present on every object that carries an `amount` or `balance` and tells you what currency those values are in. See the [Supported currencies guide](/currencies) for the full list.
 
 ## `to_base`
 
@@ -42,7 +42,7 @@ Like `amount`, `balance` is always in the `currency` of the same object and foll
 - Display amounts and balances in a single consistent currency across a multi-currency account
 - Perform arithmetic across transactions or accounts in different currencies
 
-## Sign Convention
+## Sign convention
 
 ### Transaction amounts
 
@@ -70,10 +70,10 @@ A negative balance indicates the reversed state for that account type:
 - A savings account in overdraft has a negative `balance`
 - A credit card where the issuer owes you money (e.g., after a refund or overpayment) has a negative `balance`
 
-> [!NOTE] App Display Setting
+> [!NOTE] App display setting
 > The Lunch Money app has a setting — **"Show Debits as Negative, Credits as Positive"** — that can flip how amounts are displayed in the UI. This setting is exposed in the API as `debits_as_negative` on the User object. **It has no effect on the API.** The API always returns positive values for debits and negative values for credits regardless of this setting. Apps may read `debits_as_negative` to match the user's preferred display format when showing amounts in their own UI.
 
-## Exception: Budget and Summary Amounts
+## Exception: budget and summary amounts
 
 Budget objects and summary response objects don't use the transaction sign convention. Direction is conveyed by the **structure of the response** rather than the sign of the value — amounts are always positive magnitudes, and the object type or category flag tells you whether that activity is income or expense.
 

package/docs/beta-introduction.md

@@ -1,9 +1,9 @@
 **Beta Preview Portal** — This developer portal previews planned changes including:
-- V2 API Mock Service no longer requires authentication
 - Beta versions of new [v2 API](/v2/docs) endpoints:
-  - [/crypto/manual](v2/docs#tag/crypto-manual)
-  - [/crypto/synced](v2/docs#tag/crypto-synced)
-  - [/balance/history](v2/docs#tag/balance-history)
+  - [GET /me/account/settings](v2/docs#tag/me/GET/me/account/settings)
+  - [PUT /me/account/settings](v2/docs#tag/me/PUT/me/account/settings)
+  - [GET /me/user/settings](v2/docs#tag/me/GET/me/user/settings)
+  - [PUT /me/user/settings](v2/docs#tag/me/PUT/me/user/settings)
 
 
-Feedback is welcome. [Email dev-support@lunchmoney.app](mailto:dev-support@lunchmoney.app) or join us in the [developers channel](https://discord.com/channels/842337014556262411/1134594318414389258) on the [Lunch Money Discord](https://lunchmoney.app/discord).
+Feedback is welcome. [Email dev-support@lunchmoney.app](mailto:dev-support@lunchmoney.app) or join us in the [developers channel](https://discord.com/channels/842337014556262411/1134594318414389258) on the [Lunch Money Discord](https://lunchmoney.app/discord).

package/docs/branding-your-app.md

@@ -0,0 +1,59 @@
+# Branding your app
+
+Building a tool, plugin, or integration on top of Lunch Money? Use the official **Powered by Lunch Money** badge to credit the connection clearly — without implying that your app *is* Lunch Money.
+
+<a href="https://lunchmoney.app/assets/images/media-kit/powered-by-lunch-money-badge.png" download="powered-by-lunch-money-badge.png" target="_blank" rel="noopener noreferrer" title="Download Powered by Lunch Money badge">
+  <img src="/v2/images/powered-by-lunch-money-badge.png" alt="Powered by Lunch Money badge" width="320" />
+</a>
+
+> [!TIP]
+> Click the badge to download it (or open the PNG in a new tab).
+>
+> Link it to <a href="https://lunchmoney.app/" target="_blank" rel="noopener noreferrer">lunchmoney.app</a> when you place it in a README, docs page, or app footer.
+
+For additional logos, colors, typography, screenshots, and full brand usage guidelines, see the <a href="https://lunchmoney.app/media-kit/" target="_blank" rel="noopener noreferrer">Lunch Money Media Kit</a>.
+## Naming
+
+- Refer to the product as **Lunch Money**
+- Refer to the company as **Lunchbag Labs, Inc.** when a legal or company name is needed
+- Link to <a href="https://lunchmoney.app/" target="_blank" rel="noopener noreferrer">lunchmoney.app</a> when you mention the product
+
+Avoid nicknames, abbreviations, or stylized spellings of the product name in user-facing copy.
+
+## Usage guidelines
+
+### Do
+
+- Use official logos without alteration
+- Use the **Powered by** badge when acknowledging Lunch Money
+- Keep enough clear space around logos so they stay readable
+- Download assets from the media kit rather than cropping screenshots of the logo
+
+### Don't
+
+- Stretch, rotate, or recolor logos
+- Add effects, shadows, or outlines to the logo
+- Modify the smiling coin mascot character
+- Imply endorsement, partnership, or official status without permission
+
+> [!NOTE]
+> The Lunch Money name, logo, and mascot character are trademarks of Lunchbag Labs, Inc. All rights reserved.
+
+## Suggested placements
+
+A few common, low-friction ways to brand an integration:
+
+1. **README or docs** — a short "Built with Lunch Money" line plus the Powered by badge linking to <a href="https://lunchmoney.app/" target="_blank" rel="noopener noreferrer">lunchmoney.app</a>
+2. **App footer or about screen** — the Powered by badge next to your own branding
+3. **Onboarding or connect flow** — official logo when prompting users to authorize or paste an access token
+4. **Community listings** — consistent naming ("My Tool for Lunch Money") so users can find and trust your project
+
+Keep your own product name primary. Lunch Money branding should signal the connection, not compete with your identity.
+
+## Need help?
+
+If you're unsure whether a use is appropriate, or you need a format that isn't listed here:
+
+- Start with the <a href="https://lunchmoney.app/media-kit/" target="_blank" rel="noopener noreferrer">Media Kit</a>
+- Ask in the <a href="https://lunchmoney.app/discord" target="_blank" rel="noopener noreferrer">Lunch Money Discord</a> **#developer-api** channel
+- [Email our developer advocate](mailto:jp@lunchmoney.app)

package/docs/currencies.md

@@ -1,15 +1,15 @@
-# Supported Currencies
+# Supported currencies
 
 Lunch Money supports a wide range of currencies for transactions and accounts. All currency values in the API use three-letter lowercase currency codes in ISO 4217 format.
 
-## Currency Code Format
+## Currency code format
 
 Currency codes must be:
 - Three letters
 - Lowercase
 - Valid ISO 4217 currency codes
 
-## Supported Currencies
+## Supported currencies
 
 The following currencies are currently supported in Lunch Money:
 
@@ -183,7 +183,7 @@ The following currencies are currently supported in Lunch Money:
 | `zmw` | Zambian Kwacha |
 | `zwl` | Zimbabwean Dollar |
 
-## Using Currencies in the API
+## Using currencies in the API
 
 When creating or updating transactions, accounts, or other resources that include currency information, use the three-letter lowercase currency code:
 
@@ -247,11 +247,11 @@ curl -X POST 'https://api.lunchmoney.dev/v2/transactions' \
 ```
 :::
 
-## Default Currency
+## Default currency
 
 If you don't specify a currency when creating a transaction or account, Lunch Money will default to your account's primary currency. You can check your primary currency by calling the `GET /v2/me` endpoint.
 
-## Currency Validation
+## Currency validation
 
 The API validates that currency codes match the supported list. If you provide an unsupported currency code, you'll receive a validation error:
 
@@ -268,10 +268,9 @@ The API validates that currency codes match the supported list. If you provide a
 }
 ```
 
-## Requesting New Currencies
+## Requesting new currencies
 
 If your currency is missing from the supported list, please let us know via email at [support@lunchmoney.app](mailto:support@lunchmoney.app) and we'll work on getting it added.
 
-> [!NOTE] Currency Support
+> [!NOTE] Currency support
 > Currency support is continuously expanding. If you need a currency that's not currently listed, reach out to our support team and we'll prioritize adding it.
-

package/docs/getting-started.md

@@ -1,16 +1,16 @@
-# Getting Started with the API
+# Getting started with the API
 
 Welcome to the Lunch Money developer API! This API has enabled the Lunch Money user community to build a broad set of tools and plug-ins to complement their Lunch Money experience and help other users. This guide will help you get started using the Lunch Money API.
 
 Most users interact with their Lunch Money data using the official web or mobile app. Making API calls is another way to interact with your Lunch Money data. You can make API calls that **get** your data for you, allowing you to do other things with it, like generating your own charts or simply archiving your data. You can also make API calls that **change** or **delete** your data. Any changes you make are permanent, just like they would be if you made changes using the web or mobile app.
 
 > [!WARNING]
-> Changes made via the API are permanent and cannot be undone!<br> Always use a test budget when getting started.
+> Changes made via the API are permanent and cannot be undone. Always use a test budget when getting started.
 
 
-## Create a Test Budgeting Account
+## Create a test budget account
 
-Since changes to your data made by the API are permanent, the best way to begin interacting with the API is to <a href="https://support.lunchmoney.app/miscellaneous/unlimited-budgeting-accounts" target="_blank" rel="noopener noreferrer">create a new test budgeting account</a> in your existing Lunch Money account. As you start using the API, you can interact with this test account and ensure that your real data is not modified.
+Since changes to your data made by the API are permanent, the best way to begin interacting with the API is to <a href="https://support.lunchmoney.app/miscellaneous/unlimited-budgeting-accounts" target="_blank" rel="noopener noreferrer">create a new test budget account</a> in your existing Lunch Money account. As you start using the API, you can interact with this test account and ensure that your real data is not modified.
 
 :::tabs
 
@@ -29,13 +29,13 @@ Choose the option to "Set up Demo". This will add categories, accounts, tags and
 
 ## Getting an access token
 
-Lunch Money API requests are authenticated using the Bearer Token authentication method. In plain English, this means that you will pass a token associated with your budgeting account to Lunch Money. This is so we know which account to operate on and that the request came from someone who can access that account.
+Lunch Money API requests are authenticated using the Bearer Token authentication method. In plain English, this means that you will pass a token associated with your budget account to Lunch Money. This is so we know which account to operate on and that the request came from someone who can access that account.
 
 :::tabs
 
 @tab 1. Go to the Developers Page
 
-Navigate to <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">the developers page in the Lunch Money web app</a>. Look at the green circle in the upper right hand corner and make sure that it is showing the test account that you just created. If you aren't sure which account is active, you can click on the green circle to bring up the "Switch Accounts" dialog. This will show you the full names of all the accounts associated with your account. Select the test budgeting account you created.
+Navigate to <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">the developers page in the Lunch Money web app</a>. Look at the green circle in the upper right hand corner and make sure that it is showing the test account that you just created. If you aren't sure which account is active, you can click on the green circle to bring up the "Switch Accounts" dialog. This will show you the full names of all the accounts associated with your account. Select the test budget account you created.
 ![Green Budgets Icon](/images/green_budget.png)
 
 @tab 2. Request Access Token
@@ -49,7 +49,7 @@ After you do this, the web page will show you a long alphanumeric string. This i
 Congratulations! You've got an access token and are ready to make an API request! Later, when you are more comfortable with the API, you can repeat this process to create a new access token associated with your real budget.
 
 > [!WARNING]
-> Treat your access tokens like passwords.<br>Don't share them with anyone that you don't trust. 
+> Treat your access tokens like passwords. Don't share them with anyone you don't trust.
 
 If you ever worry that your access token has been compromised, you can always come back to the Developers page and hit the Revoke button.
 
@@ -63,21 +63,21 @@ When you start to write code that makes API calls, you will need to include this
 
 ```bash
 curl --location 'https://api.lunchmoney.dev/v2/me' \
---header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
+--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
 ```
 
-If this doesn't make sense yet, that's OK! 
+If this doesn't make sense yet, that's OK!
 
-There is an easier way to use your access token to make requests. Head over to the [API Reference Documentation](/v2/docs). 
+There is an easier way to use your access token to make requests. Head over to the [API Reference Documentation](/v2/docs).
 
 :::tabs
 
 @tab 1. Supply Your Token
-Paste your new token into the box that says "Bearer Token" in the server configuration in the upper right hand corner. 
+Paste your new token into the box that says "Bearer Token" in the server configuration in the upper right hand corner.
 ![Bearer Token](/images/PasteBearer.png)
 
 @tab 2. Make a Test Request
-Scroll down to the section called "Get Current User" and hit the "Test Request" button. 
+Scroll down to the section called "Get Current User" and hit the "Test Request" button.
 ![TestRequest.png](/images/TestRequest.png)
 :::
 
@@ -85,14 +85,14 @@ This will pop up a dialog box that you can use to send an API request. This is a
 
 From here, you can explore the rest of the Lunch Money API and start thinking about what you might do with it.
 
-## What Can You Build?
+## What can you build?
 
 The Lunch Money community has already built a wide variety of tools — automations, importers, dashboards, and more. Check out the <a href="https://lunchmoney.app/developers#community-projects" target="_blank" rel="noopener noreferrer">Developer Tools & Community Projects</a> list for inspiration, or drop by the <a href="https://discord.com/channels/842337014556262411/1134597088504729780" target="_blank" rel="noopener noreferrer">Show and Tell channel</a> on Discord to see what others are sharing.
 
 > [!NOTE]
 > Built something with the API? Let us know and we'll add it to the list!
 
-## I still need help!
+## Need help?
 
 If you still aren't sure how to get started, we have other resources to help.
 

package/docs/introduction.md

@@ -2,7 +2,7 @@
 
 Welcome to the Lunch Money developer documentation. This site covers the **v2 API** — the current generation of the Lunch Money API — along with guides, a reference for the legacy v1 API, and tools for exploring the API without touching real data.
 
-## Getting Started
+## Getting started
 
 The v2 API is available at:
 
@@ -16,9 +16,9 @@ Get your access token from the <a href="https://my.lunchmoney.app/developers" ta
 Authorization: Bearer YOUR_ACCESS_TOKEN
 ```
 
-See the [Getting Started guide](/v2/getting-started) for a full walkthrough, including how to create a test budget and make your first request.
+See the [Getting started guide](/getting-started) for a full walkthrough, including how to create a test budget and make your first request.
 
-## Trying the API Without Real Data
+## Trying the API without real data
 
 The <a href="/v2/docs">interactive API reference</a> lets you make live API requests directly from the documentation — including a **static mock server** you can use to explore the API without an access token or any risk to real data.
 
@@ -34,7 +34,7 @@ Set your Bearer Token to any string of **11 or more characters** — no real tok
 
 :::
 
-## Client Libraries & SDKs
+## Client libraries & SDKs
 
 An official **TypeScript SDK** is available:
 - NPM: <a href="https://www.npmjs.com/package/@lunch-money/v2-api-spec" target="_blank" rel="noopener noreferrer">`@lunch-money/v2-api-spec`</a>
@@ -58,6 +58,6 @@ Join the conversation in the <a href="https://lunchmoney.app/discord" target="_b
 
 **Useful links:**
 - <a href="/v2/docs">Interactive API Reference</a>
-- [Getting Started Guide](/v2/getting-started)
+- [Getting started guide](/getting-started)
 - <a href="https://github.com/lunch-money/awesome-lunchmoney" target="_blank" rel="noopener noreferrer">Awesome Lunch Money Projects</a>
 - [Contact: devsupport@lunchmoney.app](mailto:devsupport@lunchmoney.app)

package/docs/locales.md

@@ -0,0 +1,124 @@
+# Supported locales
+
+Lunch Money uses locale tags to format numbers and currency amounts in the web
+and mobile apps. Date presentation is controlled separately by the user-level
+date-format settings. See
+[GET /me/user/settings](/v2/docs#tag/me/GET/me/user/settings) for those settings.
+Set the `locale` account setting to one of the supported tags below. The locale
+controls presentation details such as decimal separators, digit grouping, and
+currency symbol or code placement and rendering. It does not change the
+account's selected currency, numeric values, or the representation of dates,
+numbers, and amounts in API responses.
+
+## Locale tag format
+
+Each supported value combines a language code and a region code, separated by a
+hyphen. For example, `en-US` selects English formatting conventions for the
+United States, while `en-GB` selects English formatting conventions for the
+United Kingdom.
+
+## Supported locales
+
+The examples format `123456789` as USD. An account's primary currency determines
+the currency symbol and number of fraction digits. Exact spacing and symbol
+rendering may vary slightly by platform and its internationalization
+implementation.
+
+| Tag | Language | Region | USD `123456789` example |
+|-----|----------|--------|-------------------------|
+| `sq-AL` | Albanian | Albania | `123 456 789,00 US$` |
+| `be-BY` | Belarusian | Belarus | `123 456 789,00 $` |
+| `bg-BG` | Bulgarian | Bulgaria | `123 456 789,00 щ.д.` |
+| `ca-ES` | Catalan | Spain | `123.456.789,00 USD` |
+| `zh-CN` | Chinese (Simplified) | China | `US$123,456,789.00` |
+| `zh-HK` | Chinese (Traditional) | Hong Kong | `US$123,456,789.00` |
+| `zh-TW` | Chinese (Traditional) | Taiwan | `US$123,456,789.00` |
+| `hr-HR` | Croatian | Croatia | `123.456.789,00 USD` |
+| `cs-CZ` | Czech | Czech Republic | `123 456 789,00 US$` |
+| `da-DK` | Danish | Denmark | `123.456.789,00 US$` |
+| `nl-BE` | Dutch | Belgium | `US$ 123.456.789,00` |
+| `nl-NL` | Dutch | Netherlands | `US$ 123.456.789,00` |
+| `en-AU` | English | Australia | `USD 123,456,789.00` |
+| `en-CA` | English | Canada | `US$123,456,789.00` |
+| `en-IN` | English | India | `$12,34,56,789.00` |
+| `en-IE` | English | Ireland | `US$123,456,789.00` |
+| `en-MT` | English | Malta | `US$123,456,789.00` |
+| `en-NZ` | English | New Zealand | `US$123,456,789.00` |
+| `en-PH` | English | Philippines | `$123,456,789.00` |
+| `en-SG` | English | Singapore | `US$123,456,789.00` |
+| `en-ZA` | English | South Africa | `US$123 456 789,00` |
+| `en-GB` | English | United Kingdom | `US$123,456,789.00` |
+| `en-US` | English | United States | `$123,456,789.00` |
+| `et-EE` | Estonian | Estonia | `123 456 789,00 $` |
+| `fi-FI` | Finnish | Finland | `123 456 789,00 $` |
+| `fr-BE` | French | Belgium | `123 456 789,00 $US` |
+| `fr-CA` | French | Canada | `123 456 789,00 $ US` |
+| `fr-FR` | French | France | `123 456 789,00 $US` |
+| `fr-LU` | French | Luxembourg | `123.456.789,00 $US` |
+| `fr-CH` | French | Switzerland | `123'456'789.00 $US` |
+| `de-AT` | German | Austria | `$ 123.456.789,00` |
+| `de-DE` | German | Germany | `123.456.789,00 $` |
+| `de-LU` | German | Luxembourg | `123.456.789,00 $` |
+| `de-CH` | German | Switzerland | `$ 123'456'789.00` |
+| `el-CY` | Greek | Cyprus | `123.456.789,00 $` |
+| `el-GR` | Greek | Greece | `123.456.789,00 $` |
+| `iw-IL` | Hebrew | Israel | `‏123,456,789.00 ‏$` |
+| `hi-IN` | Hindi | India | `$12,34,56,789.00` |
+| `hu-HU` | Hungarian | Hungary | `123 456 789,00 USD` |
+| `is-IS` | Icelandic | Iceland | `123.456.789,00 USD` |
+| `in-ID` | Indonesian | Indonesia | `US$123.456.789,00` |
+| `ga-IE` | Irish | Ireland | `$123,456,789.00` |
+| `it-IT` | Italian | Italy | `123.456.789,00 USD` |
+| `it-CH` | Italian | Switzerland | `USD 123'456'789.00` |
+| `ja-JP` | Japanese | Japan | `$123,456,789.00` |
+| `ko-KR` | Korean | South Korea | `US$123,456,789.00` |
+| `lv-LV` | Latvian | Latvia | `123 456 789,00 $` |
+| `lt-LT` | Lithuanian | Lithuania | `123 456 789,00 USD` |
+| `mk-MK` | Macedonian | Macedonia | `123.456.789,00 US$` |
+| `ms-MY` | Malay | Malaysia | `USD 123,456,789.00` |
+| `mt-MT` | Maltese | Malta | `US$123,456,789.00` |
+| `no-NO` | Norwegian | Norway | `123 456 789,00 USD` |
+| `pl-PL` | Polish | Poland | `123 456 789,00 USD` |
+| `pt-BR` | Portuguese | Brazil | `US$ 123.456.789,00` |
+| `pt-PT` | Portuguese | Portugal | `123 456 789,00 US$` |
+| `ro-RO` | Romanian | Romania | `123.456.789,00 USD` |
+| `ru-RU` | Russian | Russia | `123 456 789,00 $` |
+| `sk-SK` | Slovak | Slovakia | `123 456 789,00 USD` |
+| `sl-SI` | Slovenian | Slovenia | `123.456.789,00 $` |
+| `es-AR` | Spanish | Argentina | `US$ 123.456.789,00` |
+| `es-BO` | Spanish | Bolivia | `USD 123.456.789,00` |
+| `es-CL` | Spanish | Chile | `US$123.456.789,00` |
+| `es-CO` | Spanish | Colombia | `US$ 123.456.789,00` |
+| `es-CR` | Spanish | Costa Rica | `USD 123 456 789,00` |
+| `es-DO` | Spanish | Dominican Republic | `US$123,456,789.00` |
+| `es-EC` | Spanish | Ecuador | `$123.456.789,00` |
+| `es-SV` | Spanish | El Salvador | `$123,456,789.00` |
+| `es-GT` | Spanish | Guatemala | `USD 123,456,789.00` |
+| `es-HN` | Spanish | Honduras | `USD 123,456,789.00` |
+| `es-MX` | Spanish | Mexico | `USD 123,456,789.00` |
+| `es-NI` | Spanish | Nicaragua | `USD 123,456,789.00` |
+| `es-PA` | Spanish | Panama | `USD 123,456,789.00` |
+| `es-PY` | Spanish | Paraguay | `USD 123.456.789,00` |
+| `es-PE` | Spanish | Peru | `USD 123,456,789.00` |
+| `es-PR` | Spanish | Puerto Rico | `$123,456,789.00` |
+| `es-ES` | Spanish | Spain | `123.456.789,00 US$` |
+| `es-US` | Spanish | United States | `$123,456,789.00` |
+| `es-UY` | Spanish | Uruguay | `US$ 123.456.789,00` |
+| `es-VE` | Spanish | Venezuela | `USD 123.456.789,00` |
+| `sv-SE` | Swedish | Sweden | `123 456 789,00 US$` |
+| `th-TH` | Thai | Thailand | `US$123,456,789.00` |
+| `tr-TR` | Turkish | Turkey | `$123.456.789,00` |
+| `uk-UA` | Ukrainian | Ukraine | `123 456 789,00 USD` |
+| `vi-VN` | Vietnamese | Vietnam | `123.456.789,00 US$` |
+
+## Legacy locale tags
+
+The supported list retains two legacy language codes for compatibility:
+
+- Use `iw-IL` for Hebrew (Israel). The modern language code is `he`, but
+  `he-IL` is not currently accepted by the API.
+- Use `in-ID` for Indonesian (Indonesia). The modern language code is `id`, but
+  `id-ID` is not currently accepted by the API.
+
+Use the values listed in the table when reading or updating `locale` through the
+API.