Quickstart
Make a key, send your first request and read the answer.
Make a key
An administrator of the shop opens the WeerOm admin and goes to Settings, Features, Connections. The shop must be on the Premium plan.
They give the key a name, such as "Billit", and pick what it may do:
| Pick | Kind | Starts with | For |
|---|---|---|---|
| Read | Read key | wo_live_ | A server that reads, such as an invoicing sync. |
| Read and change | Write key | wo_live_ | A server that also books, cancels and moves. |
| Take bookings from a web page | Public key | wo_pub_ | A booking page in the browser. |
This quickstart reads payments, so it needs a read key. The admin shows the key once. Copy it then.
Ask who the key belongs to
GET /shop is a good first call. It proves the key works and tells you the currency and time zone of everything else.
curl https://api.weerom.com/v1/shop \
-H "Authorization: Bearer $WEEROM_KEY"The answer:
{
"object": "shop",
"name": "Studio Noord",
"country": "BE",
"currency": "EUR",
"time_zone": "Europe/Brussels",
"locale": "nl",
"url": "https://studionoord.weerom.be"
}Read a list
Ask for the most recent payment:
curl "https://api.weerom.com/v1/payments?limit=1" \
-H "Authorization: Bearer $WEEROM_KEY"{
"object": "list",
"data": [
{
"object": "payment",
"id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",
"booking_id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",
"booking_code": "UEAMEFC9",
"paid_at": "2026-11-21T10:12:40.000Z",
"starts_at": "2026-11-21T09:30:00.000Z",
"description": "Knippen en baard",
"amount_cents": 4000,
"list_price_cents": 4000,
"discount_percent": 0,
"net_cents": 3306,
"vat_cents": 694,
"vat_percent": 21,
"tip_cents": 200,
"currency": "EUR",
"method": "bancontact",
"service_id": "c2a41f6e-8d3b-4e97-b5a0-1f7c9e2d4a68",
"staff_id": "8e1d5b7c-3a9f-4d20-b6c4-7a2e0f9d1c53",
"customer": {
"id": "5f0c9d3a-7b2e-4c61-8a4d-9e1f3b6c2d75",
"name": "Lotte Peeters",
"email": "[email protected]",
"phone": "+32470123456"
}
}
],
"has_more": true,
"next_cursor": "WzE3OTUyODcxMzA0MTIsIjBiNmYyYTRlLTVkMWMtNGY3YS05YTNlLTJjOGQxZTZmNGI5MCJd"
}Read the answer
amount_centsis what the customer paid for the service, VAT included.4000is €40.net_centsandvat_centssplit that amount. They always add up toamount_cents.tip_centssits apart and is not part ofamount_cents.paid_atis when staff noted the payment, in UTC. 10:12 UTC is 11:12 in Brussels in November.has_moreistrue, so another page follows. Sendnext_cursorback ascursorto get it. Pagination has a loop.
Next
- Authentication covers the three kinds of key, keeping a key safe and what a 401 means.
- Build a booking page shows free times and makes bookings with a public key.
- Send payments to Billit walks through an invoicing sync from start to end. The use cases list nine more.
- Webhooks tells your server about new bookings, changes and payments within seconds.
- The API reference lists every endpoint, with a playground that takes your key.