Skip to content

Add Versioning section to Environments docs page #667

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.

Sign up for GitHub

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

Closed
ls-bolt wants to merge 1 commit into from
Closed

Add Versioning section to Environments docs page #667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions mintlify/api-reference/environments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ import { topLevelProductName } from '/snippets/variables.mdx'
## Base API URL
`https://api.lightspark.com/grid/2025-10-13`

## Versioning

The date in the base URL is the API's major version. Your integration pins a version through the URL it calls, and that version's behavior does not change underneath you.

**Backwards-compatible changes.** We may extend the current version without changing the date: new endpoints, new optional request parameters, new response fields, and new enum values or webhook event types. Build your integration to ignore unrecognized response fields and to handle unfamiliar enum values gracefully.

**Major version changes.** Breaking changes — removing or renaming fields or endpoints, changing types, or making optional parameters required — ship only in a new dated version. Releasing a new version does not affect existing ones; you upgrade by changing the date in the URL whenever you are ready.

**Deprecation.** When we deprecate a version, we notify your account contact email with the migration steps and a timeline. Deprecated versions keep working for at least three months after that notice.

## Sandbox
Sandbox enables you to test your integration without making real payments. In sandbox, we expose sandbox specific APIs to trigger specific test cases like incoming payments. Additionally you'll find test UMA addresses to simulate different sending scenarios. For more information, see [Sandbox Testing](sandbox-testing).

Expand Down
Loading