Create customer

post

https://test-api.bill.pro/api/v2/profiles/{profile_id}/customers

Creates a customer on the profile. Use the customer's id when you create an order.

Only first_name, last_name and email are required. BillPro doesn't check for duplicates: two customers can have the same email or customer_id.

The response is the new customer. It doesn't include tags: use List customer tags to read them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profile_id

integer

required

≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

Body Params

customer

object

required

The customer's details.

organisation

object

Optional. The company the customer belongs to. If you send any field, send name too: a blank name with other fields filled returns 422. An organisation with every field blank is ignored.

billing_address

object

Optional. The billing address.

shipping_address

object

Optional. The shipping address. Ignored when same_as_billing_address is true. An address with only state filled isn't saved.

same_as_billing_address

boolean

Optional. true uses the billing address as the shipping address. false saves the shipping_address you send.

Optional. Tags for the customer, such as vip. Saved as described in Replace customer tags.

tag_list

Responses

Language

Credentials

Bearer

API token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Customer created.

400The body has no customer object, or it is empty.

401Missing or invalid token.

403You're not a member of this profile.

422Invalid request. Nothing is saved. A name or email is blank, the email isn't valid, date_of_birth isn't a real YYYY-MM-DD date, or the organisation has no name.