Customers
Create a customer
Creates the party you bill. Every field is optional, so you can open the record with whatever you know and fill the rest in later.
POST/v1/customers
Parameters
| Parameter | Description |
|---|---|
| country_codestring | nulloptional | At most 2 characters. |
| emailstring (email) | nulloptional | Must be a valid email address. |
| metadataobject | nulloptional | At most 50 keys. |
| namestring | nulloptional | At most 255 characters. |
| test_clockstring | nulloptional | At most 64 characters. |
Returns
The created customer. Use metadata to carry your own identifiers so records reconcile without a lookup table.
A customer on its own cannot be charged. Payment needs a mandate, and a mandate comes from Checkout.
BillKit never deduplicates customers by email. Two calls with the same address create two customers. Key on your own identifier and store the returned id.
Test it
Create the customer, then send them through Checkout to attach a mandate and start their first subscription.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the customers:write scope. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other customers operations
- List customers GET /v1/customers
- Delete customer DELETE /v1/customers/{customer_id}
- Retrieve a customer GET /v1/customers/{customer_id}
- Update customer POST /v1/customers/{customer_id}
- Purge customer POST /v1/customers/{customer_id}/purge
- Set customer VAT number POST /v1/customers/{customer_id}/vat_number
BillKit