API Changelog Diff

status="ready" · 9 endpoint changes between 2024-11-12 and 2025-09-02, 4 of them published as breaking. Expand POST /v1/refunds to see a narrowed request enum and a tightened minimum; expand GET /v1/balance_transactions to see why widening a response field to int64 breaks readers, then GET /v1/invoices for the mirror image, where widening an enum on the request side stays additive. PATCH /v1/subscriptions/{id} sits 25 days from its sunset, GET /v1/charges is 66 days past its own. Switch either version to re-ask the differ

2 releases apart

9 changes4 breaking5 additive

Removed111%Changed556%Deprecated222%Added111%

Removed1 endpoint

Not served in 2025-09-02. Every caller of these routes has to move first.

GET/v1/chargesBreakingReplaced by GET /v1/payment_intents; the route is no longer served.no field-level detail reportedSunsetAug 1, 202566 days past sunset

Changed5 endpoints

Same route in 2025-09-02, different contract. Expand a row for the field-level story.

- confirmation_tokenrequest body
  New required fieldabsentstringCreate one with POST /v1/confirmation_tokens before confirming.
  BreakingEvery existing caller omits it, so every existing call is rejected.
- next_action.typeresponse body
  Enum widenedredirect_to_url | use_sdkredirect_to_url | use_sdk | display_qr_code
  BreakingReaders switch on a closed set and now meet a value outside it.
- expand[]query parameter
  Enum widenedcustomer | subscriptioncustomer | subscription | payment_intent
  AdditiveEvery value callers already send is still accepted.
- data[].amount_overpaidresponse body
  New required fieldabsentinteger
  AdditiveAn always-present new field breaks no reader.
- reasonrequest body
  Enum narrowedduplicate | fraudulent | requested_by_customer | otherduplicate | fraudulent | requested_by_customerMap anything that used `other` onto one of the three remaining reasons.
  BreakingA value callers send today is rejected from now on.
- amountrequest body
  Constraint tightenedminimum 1minimum 50
  BreakingPayloads that validated yesterday fail the new bound.
- data[].fee_details[].amountresponse body
  Constraint relaxedint32int64Amounts can now exceed 2,147,483,647 minor units.
  BreakingValues can now exceed the bound readers sized their storage and columns for.
- created[gte]query parameter
  New optional fieldabsentinteger (unix seconds)
  AdditiveCallers that never send it keep working.
- preferred_localesresponse body
  New optional fieldabsentstring[]
  AdditiveA tolerant reader ignores a field it does not know.
- include_deletedquery parameter
  New optional fieldabsentboolean
  AdditiveCallers that never send it keep working.

Deprecated2 endpoints

Still served in 2025-09-02 and announced for retirement, with the sunset date as reported.

- statusresponse body
  Enum narrowedcanceled | incomplete_expiredcanceled
  AdditiveReaders already handle every value that remains.
Published as additive, but 1 entry below breaks callers under the request and response rules.
- proration_behaviorrequest body
  Default changedcreate_prorationsalways_invoiceCallers that omit the field now get an immediate invoice instead of a credit.
  BreakingCallers that omit the field silently get the other behaviour.

Added1 endpoint

New in 2025-09-02. Nothing written against the base version calls these.

- enabled_eventsrequest body
  New required fieldabsentstring[]
  AdditiveThe endpoint is new here, so no existing caller can be affected.
- secretresponse body
  New optional fieldabsentstring
  AdditiveThe endpoint is new here, so no existing caller can be affected.

Endpoint counts follow the breaking flag published with each change; each field badge below is derived from where the field sits and what happened to it. 1 change published as additive carries an entry that breaks callers anyway, so the breaking-only filter keeps it too.Sunset dates are reported as received and shown in UTC, with what is left of each window counted in whole days.Comparison generated Oct 6, 2025.

Comparing 2024-11-12 with 2025-09-02: the differ answered with 9 changes, so the component is rendering its ready branch.

status="loading" · the version pair is already known, so the header keeps naming what is being compared while the diff itself is still in flight; the pulse stops under prefers-reduced-motion

2024-11-122025-09-022 releases apart

status="empty" · 2025-09-02 → 2025-10-01 is a real release pair with nothing between it. Deliberately worded apart from the “no breaking changes” panel the filter produces, which is a different fact

2025-09-022025-10-011 release apart

No endpoint changes in this range

2025-09-02 and 2025-10-01 describe the same set of routes, fields and enums. Anything that moved between them was outside the API surface this diff covers.

status="error" · the message comes from the payload, “Try again” renders only because onRetry was passed, and pressing it runs a real recovery to the ready range. Focus moves to the panel that replaces the button instead of dropping to the document body

2024-11-122025-09-022 releases apart

The 2025-09-02 specification could not be fetched (502 from the spec registry).

Nothing was published, deprecated or rolled back — this view only reads two specifications and reports the difference.

Degenerate but legal data: a removed route whose path wraps and which reports no field-level detail at all — so it renders as a plain row, not a disclosure that would open onto nothing — and a deprecation with no announced sunset date, which says so instead of inventing one

2025-03-182025-09-021 release apart

2 changes1 breaking1 additive

Removed150%Changed00%Deprecated150%Added00%

Removed1 endpoint

Not served in 2025-09-02. Every caller of these routes has to move first.

DELETE/v1/organizations/{organization_id}/workspaces/{workspace_id}/members/{member_id}/permissionsBreakingPath long enough to wrap on a narrow card; no field-level detail was reported.no field-level detail reportedno sunset date announced

Deprecated1 endpoint

Still served in 2025-09-02 and announced for retirement, with the sunset date as reported.

- settlement_referenceresponse body
  Now always requiredstring | nullstring
  AdditiveReaders that coped with it missing still work.

Endpoint counts follow the breaking flag published with each change; each field badge below is derived from where the field sits and what happened to it.Comparison generated Oct 6, 2025.

The same ready payload with no now and no handlers, opened with the breaking-only filter already on: the version pair degrades to two plain labels rather than to controls that would go nowhere, the 5 rows it keeps include the PATCH published as additive whose own panel derives a breaking default change, the two sunset dates among them still print while their day counts disappear, and the composition re-totals to exactly 100% over what the filter left

2024-11-122025-09-022 releases apart

5 of 9 changes shown4 breaking1 additive

Removed120%Changed360%Deprecated120%Added00%

Removed1 endpoint

Not served in 2025-09-02. Every caller of these routes has to move first.

GET/v1/chargesBreakingReplaced by GET /v1/payment_intents; the route is no longer served.no field-level detail reportedSunsetAug 1, 2025

Changed3 endpoints

Same route in 2025-09-02, different contract. Expand a row for the field-level story.

- confirmation_tokenrequest body
  New required fieldabsentstringCreate one with POST /v1/confirmation_tokens before confirming.
  BreakingEvery existing caller omits it, so every existing call is rejected.
- next_action.typeresponse body
  Enum widenedredirect_to_url | use_sdkredirect_to_url | use_sdk | display_qr_code
  BreakingReaders switch on a closed set and now meet a value outside it.
- reasonrequest body
  Enum narrowedduplicate | fraudulent | requested_by_customer | otherduplicate | fraudulent | requested_by_customerMap anything that used `other` onto one of the three remaining reasons.
  BreakingA value callers send today is rejected from now on.
- amountrequest body
  Constraint tightenedminimum 1minimum 50
  BreakingPayloads that validated yesterday fail the new bound.
- data[].fee_details[].amountresponse body
  Constraint relaxedint32int64Amounts can now exceed 2,147,483,647 minor units.
  BreakingValues can now exceed the bound readers sized their storage and columns for.
- created[gte]query parameter
  New optional fieldabsentinteger (unix seconds)
  AdditiveCallers that never send it keep working.

Deprecated1 endpoint

Still served in 2025-09-02 and announced for retirement, with the sunset date as reported.

Published as additive, but 1 entry below breaks callers under the request and response rules.
- proration_behaviorrequest body
  Default changedcreate_prorationsalways_invoiceCallers that omit the field now get an immediate invoice instead of a credit.
  BreakingCallers that omit the field silently get the other behaviour.

Endpoint counts follow the breaking flag published with each change; each field badge below is derived from where the field sits and what happened to it. 1 change published as additive carries an entry that breaks callers anyway, so the breaking-only filter keeps it too.Sunset dates are reported as received and shown in UTC.Comparison generated Oct 6, 2025.