Billing Customers API

Design

The Billing Customers API is designed for you to be able to create a billable Staylist customer prior to building any property accounts. When you finally do build the property, you can tell us about the Billing Customer ID.

Authentication

Billing Customers require authentication

Actions

• Create a Billing Customer

Create a Whistle

Request

Make a POST request to the following endpoint:

https://app.staylists.com/api/v3/billing_customers

Parameters

All parameters are optional. But we recommend you include at least one.

• company optional, string, max chars=250
• first_name optional, string, max chars=150
• last_name optional, string, max chars=150
• phone optional, string, max chars=50
• email optional, string, max chars=70
• vat_number optional, string, max chars=20
• billing_address see below

Billing Address parameters

• company optional, string, max chars=250
• line1 optional, string, max chars=150
• line2 optional, string, max chars=150
• city optional, string, max chars=50
• state optional, string, max chars=50
• country 2-letter ISO 3166 alpha-2 country code.
• zip optional, string, max chars=20

Response

When successful

We’ll return a 200 with a body that looks something like this:

{
    "object": "BillingCustomer",
    "data": {
        "id": "16CHKwSDqpcCX7rp",
    }
}

Store this Billing Customer ID to use it with other API calls

When unsuccessful

{
    "error": "vat_number : Billing country needed to validate the VAT number."
}