API documentation
Customers
GET
/client/:customerIdRetrieve a customer
Use this endpoint to retrieve the identity, contacts, billing address, tax ID and tax preference of a customer with synchronized invoices in this account. Internal editing and data-source fields are not exposed.
Request
Build the URL with the parameters below and send the code in the Authorization header.
GET
https://stripe-ix.betacode.tech/api/v1/client/:customerIdInputs and parameters
customerIdpathstringStripe Customer ID. Starts with cus_.
Required
Request example
curl "https://stripe-ix.betacode.tech/api/v1/client/cus_Q1w2E3r4" \
-H "Authorization: Bearer ixp_test_YOUR_ACCESS_CODE" \
-H "Accept: application/json"Response
On success, this endpoint returns JSON with Content-Type application/json.
Output example
{
"id": "cus_Q1w2E3r4",
"display_name": "Acme, Lda.",
"name": "Ana Silva",
"email": "financeiro@acme.pt",
"phone": "+351 210 000 000",
"company_name": "Acme, Lda.",
"tax_id": "PT509123456",
"is_company": true,
"billing_address": {
"line1": "Rua do Comércio, 10",
"line2": null,
"city": "Lisboa",
"state": null,
"postal_code": "1100-150",
"country": "PT"
},
"preferred_tax": {
"ix_tax_rate_id": 1,
"ix_tax_rate_name": "IVA23",
"ix_tax_percent": 23,
"region": "PT",
"country_hint": "PT",
"source": "applied"
},
"vat_regime": {
"regime": "normal",
"exemption_reason": null
},
"pending_invoice_count": 1,
"invoice_count": 12
}Behavior
- The customer must belong to the same Stripe account and mode as the access code.
- Data combines the local snapshot with current Stripe information when available.
- A missing or out-of-scope customer returns 404 without revealing whether it exists in another account.
Integration notes
- preferred_tax may be null when no InvoiceXpress preference has been set.
- vat_regime.regime is normal, exempt or reverse. exemption_reason accompanies exemption or reverse charge.
- pending_invoice_count counts invoices not yet issued in InvoiceXpress.
- Optional contact and address fields may be null.