docs: mark customer email/phoneNumber conditionally required#749
Conversation
Both fields are optional on CustomerCreateRequest, but a customer whose payment provider verifies a contact channel before identity verification cannot be created without that channel's value — the request is rejected with INVALID_INPUT. Say so on the fields, matching the wording already used for the provider-conditional contactVerification object. Co-Authored-By: jklein24 <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript ✅ grid-ruby studio · code
|
Greptile Summary⚡ CONDITIONAL CONTACTS, ETERNAL RIFFS ⚡ Clarifies the customer-creation contract:
Confidence Score: 5/5The PR appears safe to merge; the source schema and both generated bundles consistently document the conditional contact requirements. The changes affect descriptions only, accurately preserve the existing schema shape, and keep both generated OpenAPI artifacts synchronized with the source.
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/customers/CustomerCreateRequest.yaml | Clarifies the region-dependent email and phone-number requirements without changing the request schema. |
| openapi.yaml | Correctly carries the source description changes into the generated root bundle. |
| mintlify/openapi.yaml | Remains synchronized with the generated root OpenAPI bundle. |
Reviews (1): Last reviewed commit: "docs: mark customer email/phoneNumber co..." | Re-trigger Greptile

Summary
CustomerCreateRequestlistsemailandphoneNumberas flatly optional, but a customer in a region that verifies a contact channel before identity verification cannot be created without that channel's value —POST /customersrejects the request withINVALID_INPUT. The spec gave integrators no way to know that, so an EU onboarding that omitsphoneNumberfails against a contract that says it's optional.Documents the conditional requirement on both fields, as a region requirement.
Changes
openapi/components/schemas/customers/CustomerCreateRequest.yaml— expandedemailandphoneNumberdescriptionsopenapi.yaml,mintlify/openapi.yaml— rebundled viamake buildDescription-only: no schema shape, type, or requirement-list change, so generated clients are unaffected and no version bump is needed.
make lint-openapipasses (0 errors).Requested by @jklein24
Original PR: #748