Create a customer
A customer is someone you sell to. Pass its id when ordering to keep track of who has what.
apiKeyAuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
application/json- body
email*stringemaillength <= 254name?stringlength <= 200externalId?stringYour own reference for this customer
length <= 200addressLines?array<>Printed under the customer name on their invoices, line by line. At most 4 lines
items <= 4taxId?stringPrinted on this customer's invoices
1 <= length <= 40country?stringWhere this customer is, for the tax rules engine to match a rule against (issue #341)
^[A-Z]{2}$region?stringThis customer's state or region, for a rule that names one
1 <= length <= 40taxOverride?|This customer’s own exception to the account’s tax rules: exempt, or a fixed rate
priceListId?stringThe list this customer is charged from. Unset, your default list
Created
application/json- response
Created
id*stringemail*stringname*string|nullexternalId*|Your own reference for this customer
priceListId*|The price list this customer is charged from; null is your default list
contractRules*integerHow many prices are agreed with this customer alone, beating their price list
addressLines*array<string>Printed under the customer name on their invoices, line by line
taxId*|Printed on this customer's invoices
country*|Where this customer is, for the tax rules engine to match a rule against (issue #341)
region*|This customer's state or region, for a rule that names one
taxOverride*||This customer’s own exception to the account’s tax rules. Null, the rules decide
taxIdCheck*|The result of the last VIES check on taxId, and when. Null, never checked
taxIdTrusted*booleanWhether you chose to treat a could-not-be-checked (taxIdCheck.valid === null) number as valid anyway
registrant*|The registrant a domain ordered for this customer falls back to, absent a per-order one, ahead of your account's default. Null until set
createdAt*stringISO 8601 timestamp
date-timecurl -X POST "https://example.com/v1/customers" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]" }'{ "id": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "email": "[email protected]", "name": "Jo Bloggs", "externalId": "crm-1042", "priceListId": null, "contractRules": 2, "addressLines": [ "1 Market Street", "San Francisco, CA 94105" ], "taxId": "12-3456789", "country": null, "region": null, "taxOverride": null, "taxIdCheck": null, "taxIdTrusted": true, "registrant": { "name": "Jo Bloggs", "organization": "Northwind Telecom", "email": "[email protected]", "phone": "+1 415 555 0132", "address": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "US", "validation": "pending" }, "createdAt": "2026-10-07T11:04:31.000Z"}