Skip to content

docs: note that fees may fluctuate with FX rates#458

Merged
pengying merged 1 commit into
mainfrom
05-11-docs_note_that_fees_may_fluctuate_with_fx_rates
May 19, 2026
Merged

docs: note that fees may fluctuate with FX rates#458
pengying merged 1 commit into
mainfrom
05-11-docs_note_that_fees_may_fluctuate_with_fx_rates

Conversation

@pengying
Copy link
Copy Markdown
Contributor

Some fee components are denominated in the receiving currency, so their
equivalent value in the sending currency moves with the FX rate between
quotes. Add a callout in the cross-currency send snippet and the Quote
System guide, and extend the OpenAPI descriptions on feesIncluded,
OutgoingRateDetails, and IncomingRateDetails so the same note shows
up in the API reference.

Some fee components are denominated in the receiving currency, so their
equivalent value in the sending currency moves with the FX rate between
quotes. Add a callout in the cross-currency send snippet and the Quote
System guide, and extend the OpenAPI descriptions on `feesIncluded`,
`OutgoingRateDetails`, and `IncomingRateDetails` so the same note shows
up in the API reference.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 11, 2026 6:48pm

Request Review

@pengying pengying marked this pull request as ready for review May 11, 2026 18:48
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 11, 2026

✱ Stainless preview builds for grid

This PR will update the grid SDKs with the following commit messages.

cli

docs: note that fees may fluctuate with FX rates

csharp

docs: note that fees may fluctuate with FX rates

go

docs: note that fees may fluctuate with FX rates

kotlin

docs(types): update fee documentation in OutgoingRateDetails, Quote, IncomingRateDetails

openapi

docs(types): clarify fee behavior in IncomingRateDetails, OutgoingRateDetails, feesIncluded

php

docs: note that fees may fluctuate with FX rates

python

docs(types): update IncomingRateDetails, OutgoingRateDetails, Quote documentation

ruby

docs: note that fees may fluctuate with FX rates

typescript

docs(api): clarify fee calculation in quotes and transactions
⚠️ grid-go studio · code

Your SDK build had a failure in the lint CI job, which is a regression from the base state.
generate ❗build ✅lint ❗test ❗

go get github.com/stainless-sdks/grid-go@a731b39259a4d39e12d1c0a63fc7233b6b16a34c
⚠️ grid-kotlin studio · code

Your SDK build had at least one warning diagnostic.
generate ✅build ✅lint ✅test ✅

⚠️ grid-python studio · code

Your SDK build had at least one warning diagnostic.
generate ✅build ✅lint ✅test ✅

pip install https://pkg.stainless.com/s/grid-python/3189861e1fa2d47e3e597d28a1cee708a439e132/grid-0.0.1-py3-none-any.whl
⚠️ grid-csharp studio · code

Your SDK build had a failure in the build CI job, which is a regression from the base state.
generate ❗build ❗lint ❗test ❗

⚠️ grid-typescript studio · code

Your SDK build had a failure in the build CI job, which is a regression from the base state.
generate ✅build ❗lint ❗test ❗

⚠️ grid-php studio · code

Your SDK build had at least one "error" diagnostic.
generate ❗lint ✅test ✅

⚠️ grid-cli studio · code

Your SDK build had a failure in the build CI job, which is a regression from the base state.
generate ⚠️build ❗lint ❗test ❗

⚠️ grid-openapi studio · code

Your SDK build had at least one warning diagnostic.
generate ✅

⚠️ grid-ruby studio · code

Your SDK build had a failure in the lint CI job, which is a regression from the base state.
generate ⚠️build ✅lint ❗test ✅


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-19 00:42:23 UTC

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 11, 2026

Greptile Summary

This docs-only PR adds a clarifying note across three locations — the cross-currency sending snippet, the Quote System guide, and the OpenAPI schema descriptions — explaining that fee components denominated in the receiving currency (specifically counterpartyFixedFee for outgoing and gridApiFixedFee for incoming transfers) fluctuate with the FX rate between quote requests.

  • OpenAPI descriptions for IncomingRateDetails, OutgoingRateDetails, and feesIncluded on Quote are updated consistently in both the source YAML files (openapi/components/schemas/…) and the bundled outputs (openapi.yaml, mintlify/openapi.yaml).
  • MDX callouts (<Note>) are added to cross-currency.mdx (inside the relevant step) and quote-system.mdx (after the fee-calculation example), naming the specific fee fields in quote-system.mdx while keeping the snippet-level note intentionally generic.

Confidence Score: 5/5

Documentation-only change with no logic, schema contracts, or runtime behavior altered; safe to merge.

All changes are additive prose additions to OpenAPI descriptions and MDX callouts. The source YAML files are edited correctly, and the bundled outputs reflect the same changes, consistent with the make build workflow. Wording is accurate and consistent across all seven files.

No files require special attention.

Important Files Changed

Filename Overview
mintlify/snippets/sending/cross-currency.mdx Adds a <Note> callout inside the "Fetch a quote" step explaining fee fluctuation; placement and Mintlify component choice are appropriate.
mintlify/platform-overview/core-concepts/quote-system.mdx Adds a <Note> callout after the fee-calculation example, naming both counterpartyFixedFee and gridApiFixedFee specifically; consistent with the OpenAPI descriptions.
openapi/components/schemas/quotes/Quote.yaml Extends feesIncluded description with FX-rate fluctuation note; wording is consistent with the other changed schema files.
openapi/components/schemas/transactions/IncomingRateDetails.yaml Adds FX-rate fluctuation note for gridApiFixedFee to the schema description; correctly uses >- block scalar.
openapi/components/schemas/transactions/OutgoingRateDetails.yaml Adds FX-rate fluctuation note for counterpartyFixedFee to the schema description; correctly uses >- block scalar.
openapi.yaml Generated bundle updated by make build; changes match the source YAML edits in openapi/components/schemas/.
mintlify/openapi.yaml Generated Mintlify bundle updated by make build; identical changes to root openapi.yaml.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([Client requests quote]) --> B[POST /quotes]
    B --> C{Cross-currency?}
    C -- No --> D[feesIncluded fixed in sending currency]
    C -- Yes --> E[Fee components split by currency]
    E --> F["counterpartyFixedFee\n(denominated in receiving currency)"]
    E --> G["counterpartyMultiplier\n(rate-based, dimensionless)"]
    F --> H["Converted to sending currency\nat current FX rate"]
    G --> H
    H --> I["feesIncluded = total fees\nlocked for quote lifetime"]
    I --> J{Quote still valid?}
    J -- Yes --> K[Execute quote — fees guaranteed]
    J -- No / new quote --> L["New FX rate applied →\nfeesIncluded may differ"]
    L --> B
Loading

Reviews (1): Last reviewed commit: "docs: note that fees may fluctuate with ..." | Re-trigger Greptile

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 11, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview May 11, 2026, 6:56 PM

@pengying pengying merged commit cf69ef0 into main May 19, 2026
9 checks passed
@pengying pengying deleted the 05-11-docs_note_that_fees_may_fluctuate_with_fx_rates branch May 19, 2026 00:40
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.

2 participants