From 4c5fad3a450b7ae6744c49100d19fa947a75520b Mon Sep 17 00:00:00 2001 From: Jeremy Date: Wed, 8 Jul 2026 00:20:55 +0000 Subject: [PATCH 1/2] docs: add Versioning section to Environments page --- mintlify/api-reference/environments.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/mintlify/api-reference/environments.mdx b/mintlify/api-reference/environments.mdx index e23f59148..6e9e1428d 100644 --- a/mintlify/api-reference/environments.mdx +++ b/mintlify/api-reference/environments.mdx @@ -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). From 2687f1dab2001eb36bbb772c38ae4d97b11832ce Mon Sep 17 00:00:00 2001 From: Jeremy Date: Wed, 8 Jul 2026 00:29:59 +0000 Subject: [PATCH 2/2] Align deprecation wording with MSA migration-period terms Deprecated-version support is stated as a migration window (normally at least three months, shorter for security/compliance-critical updates) instead of an unconditional three-month availability guarantee. --- mintlify/api-reference/environments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mintlify/api-reference/environments.mdx b/mintlify/api-reference/environments.mdx index 6e9e1428d..fc8aab298 100644 --- a/mintlify/api-reference/environments.mdx +++ b/mintlify/api-reference/environments.mdx @@ -18,7 +18,7 @@ The date in the base URL is the API's major version. Your integration pins a ver **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. +**Deprecation.** When we deprecate a version, we notify your account contact email with the migration steps and a deadline. The migration window is normally at least three months; updates critical to security or compliance may require faster action. After the window, deprecated versions are no longer supported. ## 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).