Chauffeur Circle Docs

Getting started

Getting started

This guide takes you from a new account to your first booking on your own website. Every step after sign-up happens in the Chauffeur Circle dashboard.

How Chauffeur Circle fits together

Your website ──(widget or your own form)──▶ Chauffeur Circle API ──▶ Square (your account)
                                                │
                    Dashboard ◀─────────────────┘──▶ Emails to you and the passenger
  • Passengers book on your website. The widget (or your own form) talks to the Chauffeur Circle API with a publishable key.
  • Cards are typed into Square's secure form inside a Chauffeur Circle frame. Your site and Chauffeur Circle never see card numbers.
  • You manage bookings, prices and settings in the dashboard.

1. Create your account

Go to chauffeurcircle.com, pick a plan and press Start free trial. Every plan has a 14-day free trial; you can add a card for the subscription now or later from Billing.

2. Connect Square

Ride payments go to your own Square account. See Connect Square.

3. Add vehicles and prices

Add each vehicle type with how many you have, then rates, airport fares, surcharges and extras. See Vehicles & rates.

4. Check your policies

In Settings, check your support email and phone, time zone, booking lead time, gratuity and tax, and your cancellation policy:

Setting Default What it does
Hold before pickup 48 hours When the card is held for the estimated total
Hold buffer 20% Extra held on top, for tolls and waiting time
Free cancellation 24 hours Passengers can cancel free until this long before pickup
Late cancellation fee 50% Charged for later cancellations
No-show fee 100% Charged when you mark the ride as a no-show
Card fix deadline 12 hours How long before pickup a failed card must be replaced

5. Get your API key and add your domain

Open API keys. You have two publishable keys:

  • cc_pk_test_… works on localhost and *.pages.dev as well as your domains, for trying things out.
  • cc_pk_live_… works only on the domains you list.

Add your website's domain (for example www.yourlimo.com, or *.yourlimo.com for all subdomains) to the live key. Requests from any other site are refused.

Publishable keys are safe in your website

They can only get prices and create bookings from your listed domains. Secret keys (cc_sk_…, Business plan) are for your server and must never appear in a web page.

6. Put the widget on your website

Open Widget in the dashboard, set your colours and copy the code for the embed style you want. Paste it into your site. See Embed modes and the guides for website builders and frameworks.

7. Make a test booking

Book a ride on your site with your test key and Square's sandbox card. See Testing with Square sandbox.

When you are ready, connect your production Square account and use your live key. The dashboard's checklist shows what is left.