Skip to content

Document customer billing address on customer schema (API v2.2.1)#10

Draft
acallaghan wants to merge 2 commits into
mainfrom
claude/great-ptolemy-96Rmw
Draft

Document customer billing address on customer schema (API v2.2.1)#10
acallaghan wants to merge 2 commits into
mainfrom
claude/great-ptolemy-96Rmw

Conversation

@acallaghan
Copy link
Copy Markdown
Contributor

@acallaghan acallaghan commented Jun 8, 2026

What

Documents the customer billing address object in the OpenAPI spec. The API already returns this object (via SvixEvents::CustomerSerializer), but it was undocumented.

Changes

  • New reusable customer_billing_address schema with: company, address_1, address_2, town, state, postcode, country (ISO 3166-1 alpha-2) and a formatted_address convenience string (full address as a single comma-separated line, country name expanded).
  • Added an address property (referencing the new schema) to the customer schema. It is null when the customer has no billing address.
  • Added the address block to the customer_example.
  • Bumped info.version 2.2.0 → 2.2.1 and added a changelog entry.

This applies to GET /customers, GET /customers/{id}, and the customer.created / customer.updated webhooks. No breaking changes — it documents an existing response field.

Notes

  • The Postman collection (v2/jammed-postman-collection.json) is regenerated automatically by the Update Postman Collection Action on push to claude/**, so it isn't hand-edited here. I verified openapi2postmanv2 converts the updated spec cleanly.
  • This unblocks the corresponding jammed-org/zapier change that surfaces the billing address in the Zapier integration output.

Testing

  • python3 -c "import yaml; yaml.safe_load(...)" — spec parses; customer.address and customer_billing_address resolve correctly.
  • openapi2postmanv2 -s v2/jammed.yaml — conversion successful.

https://claude.ai/code/session_01RwYPyNgFzwDxnJLX4gPCde


Generated by Claude Code


Note

Low Risk
Documentation-only OpenAPI and changelog updates; no API behavior changes.

Overview
Documents the customer address field in OpenAPI for API v2.2.1, matching payloads the API already returns on customer list/detail and customer.created / customer.updated webhooks.

Adds a reusable customer_billing_address schema (company, address lines, town, state, postcode, ISO country code, and formatted_address) and wires address on the customer schema (nullable when unset), plus an example on customer_example. info.version moves to 2.2.1 with a matching changelog.md entry. No runtime or contract change—spec-only documentation.

Reviewed by Cursor Bugbot for commit 3bd2be2. Bugbot is set up for automated code reviews on this repo. Configure here.

claude and others added 2 commits June 8, 2026 09:21
Add a `customer_billing_address` schema and reference it from the
`customer` schema's new `address` property. The API already returns this
object on GET /customers, GET /customers/{id}, and the customer.created /
customer.updated webhooks; this documents it. Includes company,
address_1, address_2, town, state, postcode, country (ISO 3166-1
alpha-2) and a formatted_address convenience string, and adds it to the
customer example. Bump spec version to 2.2.1.

https://claude.ai/code/session_01RwYPyNgFzwDxnJLX4gPCde
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying api with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3bd2be2
Status: ✅  Deploy successful!
Preview URL: https://f81131a2.api-dwa.pages.dev
Branch Preview URL: https://claude-great-ptolemy-96rmw.api-dwa.pages.dev

View logs

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