docs: billing policy changes and property address id support#42
Merged
Conversation
trichardswp
force-pushed
the
docs/billing-policy-2026-06-01
branch
from
ea9c735 to
802cbd0
Compare
Billing changes effective 2026-06-01: billable responses are 2xx
everywhere plus 404 on person and property endpoints, except 404 on
GET /v2/property/{property_id}, which is never billed to encourage
optimistic lookups by address ID. No other response is billed.
Document that /v2/property/{property_id} accepts either a property
ID (R prefix) or an address ID (A prefix), regenerate the reference
page from the live spec, and add a changelog entry. Archive the
prior policy at an unlisted page, Billing Policy For Usage Prior to
2026-06-01, linked from the billing page and changelog.
Also exclude the Internal Ledger tag from openapi generation so
internal endpoints are never published to the public docs to reduce
potential confusion about externally accessible vs internally accessible
endpoints.
trichardswp
force-pushed
the
docs/billing-policy-2026-06-01
branch
from
802cbd0 to
5a37564
Compare
lhagenWP
approved these changes
Jun 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the 2026-06-01 billing policy changes and the new address ID support on
GET /v2/property/{property_id}. Billable responses are now 2xx everywhere plus 404 on every person and property endpoint except property-by-id; 400, 403, 429, and 5xx are never billed.Also fixes the OpenAPI generator to exclude the Internal facing endpoints that may confuse external users who cannot access these endpoints.
Changes
content/docs/references/billing.mdx— rewritten billing rules effective 2026-06-01, with a policy-change callout and an explanation of why property-by-id 404s are never billedcontent/docs/references/billing-prior-to-2026-06-01.mdx— archived prior policy (2xx + 4xx billable), unlisted from the sidebar viameta.jsonbut routable for customers with pre-June usagecontent/docs/changelog/index.mdx— June 1, 2026 entry covering address ID support and billability changes, linking both policiescontent/docs/documentation/property-search.mdx— new section documenting property details lookup by property ID (Rprefix) or address ID (Aprefix), with a callout that 404s on this endpoint are not billedcontent/docs/references/property-v2/get_property_by_id_v2.mdx— regenerated from the live OpenAPI spec, picking up the address ID descriptioncontent/docs/documentation/getting-started.mdx— billing sentence now links to the full policyscripts/generators/openapi/— addedEXCLUDED_TAGSso the Internal endpoints of the api are not confusingly published to the public documentation where they are inaccessible.