Booking policies

2 operations. Every schema and example on this page is generated from the platform contract.

GET/api/v1/booking-policies

A store's booking terms.

Public, because a customer deciding whether to book needs to see the cancellation terms BEFORE they commit, and a partner rendering our availability must be able to state them accurately rather than invent them.

auth none, publicop getBookingPoliciesrate limited errors

Parameters

store_idstring · uuidqueryrequired

The store whose booking terms you want.

Response, 200

cancel_window_hoursnumber, nullablerequired

cancel_fee_percentnumber, nullablerequired

no_show_fee_percentnumber, nullablerequired

lead_time_minnumber, nullablerequired

How far ahead a booking must be made.

horizon_daysnumber, nullablerequired

How far ahead booking is open.

slot_increment_minnumber, nullablerequired

hold_ttl_minnumber, nullablerequired

How long a slot is reserved while paying.

walkin_modestring, nullablerequired

'appointments_only' | 'walk_ins_only' | 'mixed'.

deposit_policyobjectrequired

What deposit this store takes: {"type":"none"} | {"type":"flat","amount_pence":N} | {"type":"percent","percent":N} | {"type":"per_head",…}. Exposed on the READ because the merchant setup screen has to show what is currently set, and because a fee can only ever be taken from a deposit, so a partner rendering the terms cannot state them honestly without it.

table_choice_levelnumber, nullablerequired

Who chooses the table: 0 the restaurant seats the party, 1 the diner picks where to sit (the customer app shows the floor plan), 2 reserved. On the READ because the merchant setup screen has to show which one is live. Null only when the store has no policy row, which behaves exactly as 0.

curl -G "https://www.membber.com/api/v1/booking-policies" \
  --data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.GET("/api/v1/booking-policies", {
  params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.getBookingPolicies(
    query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json

print(response)

Response, 200

{
  "cancel_window_hours": 1,
  "cancel_fee_percent": 1,
  "no_show_fee_percent": 1,
  "lead_time_min": 1,
  "horizon_days": 1,
  "slot_increment_min": 1,
  "hold_ttl_min": 1,
  "walkin_mode": "<walkin_mode>",
  "deposit_policy": {},
  "table_choice_level": 1
}

PUT/api/v1/booking-policies

Set a store booking policy.

Creates or partially updates the store booking policy (one row per store). Only the fields you send change; the rest keep their current value or the store default. Idempotent, the same write converges on the same row. Deposit/fee fields are stored but do not move money until the money stage. For a restaurant, `table_choice_level` is the floor-plan switch: 1 lets diners see the room and pick where to sit, 0 hands seating back to the restaurant.

auth merchant:writeop writeBookingPolicyidempotent retry rate limited errors

Request body

store_idstring · uuidrequired

cancel_window_hoursintegeroptional

How long before the appointment a free cancel is allowed.

cancel_fee_percentintegeroptional

Percent of price charged for a late cancel. WRITABLE but INERT until the money stage.

no_show_fee_percentintegeroptional

Percent of price charged for a no-show. WRITABLE but INERT until the money stage.

lead_time_minintegeroptional

How far ahead a booking must be made, in minutes.

horizon_daysintegeroptional

How far ahead booking is open, in days.

slot_increment_minintegeroptional

The customer-facing slot grain, in minutes.

hold_ttl_minintegeroptional

How long a slot is reserved while paying, in minutes.

walkin_modeenumoptional

'appointments_only' | 'walk_ins_only' | 'mixed'.

appointments_onlywalk_ins_onlymixed

booking_modeenumoptional

'appointments' (chairs) | 'tables' (restaurant). Seeded from the signup category.

appointmentstables

deposit_policyobjectoptional

Deposit policy JSON. WRITABLE but INERT, no charge is wired from it here.

table_choice_levelintegeroptional

Who chooses the table when a diner books online: 0 = the restaurant seats them (the default), 1 = the diner sees the room and picks where to sit (the customer app shows the floor plan). 2 is reserved and refused.

Response, 200

store_idstringrequired

cancel_window_hoursnumberrequired

cancel_fee_percentnumberrequired

no_show_fee_percentnumberrequired

lead_time_minnumberrequired

horizon_daysnumberrequired

slot_increment_minnumberrequired

hold_ttl_minnumberrequired

walkin_modestringrequired

booking_modestringrequired

deposit_policyobjectrequired

table_choice_levelnumberrequired

Who chooses the table: 0 the restaurant, 1 the diner, 2 reserved (only ever set by hand).

curl -X PUT "https://www.membber.com/api/v1/booking-policies" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "6659c139-0000-4000-8000-d0c500000066"
  }'

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.PUT("/api/v1/booking-policies", {
  body: {
    store_id: "6659c139-0000-4000-8000-d0c500000066"
  },
  headers: { "Idempotency-Key": crypto.randomUUID() },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.writeBookingPolicy(
    body: .json(.init(
        storeId: "6659c139-0000-4000-8000-d0c500000066"
    ))
).ok.body.json

print(response)

Response, 200

{
  "store_id": "6659c139-0000-4000-8000-d0c500000066",
  "cancel_window_hours": 1,
  "cancel_fee_percent": 1,
  "no_show_fee_percent": 1,
  "lead_time_min": 1,
  "horizon_days": 1,
  "slot_increment_min": 1,
  "hold_ttl_min": 1,
  "walkin_mode": "<walkin_mode>",
  "booking_mode": "<booking_mode>",
  "deposit_policy": {},
  "table_choice_level": 1
}