Drops
The variables a template can print and branch on, per route. Nothing else is there: an unknown variable fails the
render (strict variables). Every value is plain text, a number, true or false, nil, a list or an object of those;
printed values are HTML-escaped. Branch on state fields with {% if state.empty %}. URLs are built by Truly.
The layout sees the drops of the page it wraps.
booking.locations
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location_count |
integer | How many locations can be booked. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when no location can be booked. |
locations |
list of objects | The locations and the tenant's coming-soon tiles, in the tenant's order. |
locations[].name |
string | The location's name. |
locations[].area |
string or nil | Its area label. |
locations[].region |
string or nil | Its region. |
locations[].url |
string or nil | The address of its booking; nil for a coming-soon tile. |
locations[].coming_soon |
boolean | True for a tile of a location that is not open yet. |
booking.services
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location |
object | The location the booking is at. |
location.name |
string | The location's name. |
location.address_line |
string or nil | Street and number. |
location.postal_code |
string or nil | Postal code. |
location.city |
string | City. |
location.phone |
string or nil | Phone number, as text (no tel: links). |
location.phone_hours |
string or nil | When the phone is answered. |
location.email |
string or nil | Email address, as text (no mailto: links). |
location.maps_url |
string or nil | A link to the location on a map. |
location.opening_hours |
list of objects | This week's opening hours, Monday to Sunday (holidays and one-off changes are not included). |
location.opening_hours[].weekday |
integer | 1 for Monday to 7 for Sunday. |
location.opening_hours[].day |
string | The day's name in the page's language. |
location.opening_hours[].closed |
boolean | True when the location is closed all day. |
location.opening_hours[].hours |
list of objects | The day's opening intervals. |
location.opening_hours[].hours[].opens |
string | Opening time, HH:MM. |
location.opening_hours[].hours[].closes |
string | Closing time, HH:MM; 24:00 is midnight. |
location.area |
string or nil | The location's area label, for example "Vesterbro · København". |
location.region |
string or nil | The region the location belongs to, for grouping. |
service_count |
integer | How many services can be booked here. |
categories |
list of objects | Every service category of the tenant, in its order, including empty ones; services without a category are not in a row. |
categories[].name |
string | The category's name in the page's language. |
categories[].description |
string or nil | Its description in the page's language, if any. |
categories[].service_count |
integer | How many of its services can be booked at this location. |
categories[].empty |
boolean | True when none of them can. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when no service can be booked here. |
booking.staff
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location |
object | The location the booking is at. |
location.name |
string | The location's name. |
location.address_line |
string or nil | Street and number. |
location.postal_code |
string or nil | Postal code. |
location.city |
string | City. |
location.phone |
string or nil | Phone number, as text (no tel: links). |
location.phone_hours |
string or nil | When the phone is answered. |
location.email |
string or nil | Email address, as text (no mailto: links). |
location.maps_url |
string or nil | A link to the location on a map. |
location.opening_hours |
list of objects | This week's opening hours, Monday to Sunday (holidays and one-off changes are not included). |
location.opening_hours[].weekday |
integer | 1 for Monday to 7 for Sunday. |
location.opening_hours[].day |
string | The day's name in the page's language. |
location.opening_hours[].closed |
boolean | True when the location is closed all day. |
location.opening_hours[].hours |
list of objects | The day's opening intervals. |
location.opening_hours[].hours[].opens |
string | Opening time, HH:MM. |
location.opening_hours[].hours[].closes |
string | Closing time, HH:MM; 24:00 is midnight. |
location.area |
string or nil | The location's area label, for example "Vesterbro · København". |
location.region |
string or nil | The region the location belongs to, for grouping. |
service |
object | The chosen service. |
service.name |
string | The service's name. |
staff |
list of objects | The staff the customer can choose, in the step's order. |
staff[].name |
string | The name shown for the employee. |
staff[].also_at |
list of string | The names of the employee's other locations. |
staff_count |
integer | How many staff can be chosen. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when nobody can do the service. |
booking.times
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location |
object | The location the booking is at. |
location.name |
string | The location's name. |
location.address_line |
string or nil | Street and number. |
location.postal_code |
string or nil | Postal code. |
location.city |
string | City. |
location.phone |
string or nil | Phone number, as text (no tel: links). |
location.phone_hours |
string or nil | When the phone is answered. |
location.email |
string or nil | Email address, as text (no mailto: links). |
location.maps_url |
string or nil | A link to the location on a map. |
location.opening_hours |
list of objects | This week's opening hours, Monday to Sunday (holidays and one-off changes are not included). |
location.opening_hours[].weekday |
integer | 1 for Monday to 7 for Sunday. |
location.opening_hours[].day |
string | The day's name in the page's language. |
location.opening_hours[].closed |
boolean | True when the location is closed all day. |
location.opening_hours[].hours |
list of objects | The day's opening intervals. |
location.opening_hours[].hours[].opens |
string | Opening time, HH:MM. |
location.opening_hours[].hours[].closes |
string | Closing time, HH:MM; 24:00 is midnight. |
location.area |
string or nil | The location's area label, for example "Vesterbro · København". |
location.region |
string or nil | The region the location belongs to, for grouping. |
service |
object | The chosen service. |
service.name |
string | The service's name. |
slot_count |
integer | How many times are shown. |
days |
list of objects | The days shown (7, or a calendar month with ?view=month). |
days[].date |
string | The day, YYYY-MM-DD. |
days[].status |
string | past, available, closed (no opening hours that day) or full. |
days[].selected |
boolean | True for the day whose times are shown. |
days[].url |
string or nil | The address that shows the day; nil for a past day. |
previous_url |
string or nil | The address of the previous week or month; nil at today. |
next_url |
string | The address of the next week or month. |
week_url |
string | The week view of the selected day. |
month_url |
string | The month view of the selected day. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when no time is free. |
booking.details
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location |
object | The location the booking is at. |
location.name |
string | The location's name. |
location.address_line |
string or nil | Street and number. |
location.postal_code |
string or nil | Postal code. |
location.city |
string | City. |
location.phone |
string or nil | Phone number, as text (no tel: links). |
location.phone_hours |
string or nil | When the phone is answered. |
location.email |
string or nil | Email address, as text (no mailto: links). |
location.maps_url |
string or nil | A link to the location on a map. |
location.opening_hours |
list of objects | This week's opening hours, Monday to Sunday (holidays and one-off changes are not included). |
location.opening_hours[].weekday |
integer | 1 for Monday to 7 for Sunday. |
location.opening_hours[].day |
string | The day's name in the page's language. |
location.opening_hours[].closed |
boolean | True when the location is closed all day. |
location.opening_hours[].hours |
list of objects | The day's opening intervals. |
location.opening_hours[].hours[].opens |
string | Opening time, HH:MM. |
location.opening_hours[].hours[].closes |
string | Closing time, HH:MM; 24:00 is midnight. |
location.area |
string or nil | The location's area label, for example "Vesterbro · København". |
location.region |
string or nil | The region the location belongs to, for grouping. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.online_payment |
boolean | True when the booking is paid online now. |
state.pay |
boolean | True when an amount is due whatever the credit switch says, so the step goes on to the payment step. |
state.terms |
boolean | True when the customer must accept the terms. |
state.marketing |
boolean | True when the tenant asks for marketing consent. |
state.signed_in |
boolean | True when the customer is signed in. |
booking.booking
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location |
object | The location the booking is at. |
location.name |
string | The location's name. |
location.address_line |
string or nil | Street and number. |
location.postal_code |
string or nil | Postal code. |
location.city |
string | City. |
location.phone |
string or nil | Phone number, as text (no tel: links). |
location.phone_hours |
string or nil | When the phone is answered. |
location.email |
string or nil | Email address, as text (no mailto: links). |
location.maps_url |
string or nil | A link to the location on a map. |
location.opening_hours |
list of objects | This week's opening hours, Monday to Sunday (holidays and one-off changes are not included). |
location.opening_hours[].weekday |
integer | 1 for Monday to 7 for Sunday. |
location.opening_hours[].day |
string | The day's name in the page's language. |
location.opening_hours[].closed |
boolean | True when the location is closed all day. |
location.opening_hours[].hours |
list of objects | The day's opening intervals. |
location.opening_hours[].hours[].opens |
string | Opening time, HH:MM. |
location.opening_hours[].hours[].closes |
string | Closing time, HH:MM; 24:00 is midnight. |
location.area |
string or nil | The location's area label, for example "Vesterbro · København". |
location.region |
string or nil | The region the location belongs to, for grouping. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | hold, cancelled or confirmed. |
state.withdrawal |
boolean | True when the right of withdrawal applies, so the withdrawal notice shows. |
booking.payment
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
location |
object | The location the booking is at. |
location.name |
string | The location's name. |
location.address_line |
string or nil | Street and number. |
location.postal_code |
string or nil | Postal code. |
location.city |
string | City. |
location.phone |
string or nil | Phone number, as text (no tel: links). |
location.phone_hours |
string or nil | When the phone is answered. |
location.email |
string or nil | Email address, as text (no mailto: links). |
location.maps_url |
string or nil | A link to the location on a map. |
location.opening_hours |
list of objects | This week's opening hours, Monday to Sunday (holidays and one-off changes are not included). |
location.opening_hours[].weekday |
integer | 1 for Monday to 7 for Sunday. |
location.opening_hours[].day |
string | The day's name in the page's language. |
location.opening_hours[].closed |
boolean | True when the location is closed all day. |
location.opening_hours[].hours |
list of objects | The day's opening intervals. |
location.opening_hours[].hours[].opens |
string | Opening time, HH:MM. |
location.opening_hours[].hours[].closes |
string | Closing time, HH:MM; 24:00 is midnight. |
location.area |
string or nil | The location's area label, for example "Vesterbro · København". |
location.region |
string or nil | The region the location belongs to, for grouping. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.open |
boolean | True while the hold can still be paid. |
state.withdrawal |
boolean | True when the right of withdrawal applies, so the model withdrawal form shows. |
memberships.plans
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
plan_count |
integer | How many plans are shown. |
plans |
list of objects | The plans, in the list's order. |
plans[].name |
string | The plan's name in the page's language. |
plans[].perks |
list of string | The plan's perks, one line each, in the page's language. |
plans[].note |
string or nil | A note on the plan in the page's language, if any. |
plans[].interval |
string | How often it is paid, worded ("Hver måned", "Every 3 months"). |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when there are no plans. |
state.signed_in |
boolean | True when the customer is signed in. |
memberships.signup
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
plan |
object | The plan being signed up for. |
plan.name |
string | The plan's name in the page's language. |
plan.perks |
list of string | The plan's perks, one line each. |
plan.note |
string or nil | A note on the plan, if any. |
plan.interval |
string | How often it is paid, worded. |
plan.credits |
string | The plan's credits per period, worded. |
plan.credit_expiry |
string or nil | When unused credits expire, worded; nil when they do not. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.signed_in |
boolean | True when the customer is signed in. |
state.withdrawal_form |
boolean | True when the model withdrawal form may show. |
memberships.confirmation
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | awaiting_card (the card is not saved yet), card_saved (an imported membership whose card is saved; its first charge is on its next period), charging (the first payment is being taken), payment_failed (the first payment was declined; the page offers the pay link), not_paid (the membership was terminated or withdrawn) or confirmed. |
plan |
object | The plan signed up for. |
plan.name |
string | The plan's name in the page's language. |
plan.price |
string or nil | The price per period, worded with the currency. |
plan.interval_months |
integer | How many months a period is. |
plan.interval |
string | How often it is paid, worded. |
plan.started_on |
string or nil | The start date, worded; nil until the sign-up is confirmed. |
plan.next_charge_on |
string or nil | The next payment's date, worded; nil until confirmed. |
plan.binding_ends_on |
string or nil | When the binding period ends, worded; nil until confirmed or without one. |
customers.sign_in
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.sms |
boolean | True when the customer can sign in by SMS. |
state.passkey |
boolean | True when the form offers passkeys. |
customers.sign_in_code
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | entry, locked or expired. |
customers.membership
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.running |
boolean | True when a running membership is shown; place membership_termination then. |
customers.bookings
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.booking_reschedule
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.profile
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.saved_cards
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.consents
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.referral
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.waitlist
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.data_export
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
customers.deletion_request
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
withdrawals.order
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | open, late (past the deadline) or ended (the right has ended). |
withdrawals.order_receipt
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
withdrawals.membership
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | open, late (past the deadline) or ended (the right has ended). |
withdrawals.membership_receipt
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
punch_cards.list
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when no punch card is for sale. |
waitlist.join
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.joined |
boolean | True right after the customer joined. |
state.signed_in |
boolean | True when the customer is signed in. |
waitlist.entry
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | active, booked, cancelled or expired. |
legal.text
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.found |
boolean | True when the tenant has published this text. |
errors.not_found
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
catalog.price_list
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.empty |
boolean | True when the price list has no categories. |
sickness_recovery.case
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.choosing |
boolean | True while the customer can still choose a new time. |
messaging.unsubscribe
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | confirm, done or invalid (the link is not valid). |
memberships.card_link_unavailable
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.reason |
string | superseded, refused, expired or completed. |
memberships.invitation_unavailable
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.reason |
string | used or expired. |
errors.too_many_requests
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
checkout.payment_link
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | open, paid or expired. |
checkout.order_status
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | awaiting_verification, not_paid or confirmed. |
state.withdrawal |
boolean | True when the paid order shows the withdrawal notice. |
waitlist.offer
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | open, taken, held or ended. |
state.book |
boolean | True when the time is booked on the page, with the cancellation policy and the button. |
state.terms |
boolean | True when the terms box shows. |
growth.offer
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | open, taken, held, booked or expired. |
state.book |
boolean | True when the time is booked on the page, with the cancellation policy and the button. |
state.terms |
boolean | True when the terms box shows. |
punch_cards.purchase
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.withdrawal_form |
boolean | True when the right of withdrawal applies, so the model withdrawal form shows. |
state.signed_in |
boolean | True when the customer is signed in and buys as themselves. |
punch_cards.purchase_status
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | awaiting_verification, not_paid or confirmed. |
gift_cards.purchase
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.withdrawal_form |
boolean | True when the right of withdrawal applies, so the model withdrawal form shows. |
state.signed_in |
boolean | True when the customer is signed in and buys as themselves. |
gift_cards.purchase_status
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | awaiting_verification, not_paid or confirmed. |
memberships.card_link
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.change |
boolean | True when the link replaces a saved card and orders nothing. |
memberships.card_link_login
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | offer, entry, expired, locked, claimed or conflict (the login step's state). |
memberships.card_link_status
| Field | Type | Meaning |
|---|---|---|
tenant |
object | The tenant whose booking pages these are. |
tenant.name |
string | The tenant's name. |
tenant.website_url |
string or nil | The tenant's own website, if set. |
tenant.nav_links |
list of objects | The tenant's menu links, in their order (at most 8). |
tenant.nav_links[].label |
string | The link's text in the page's language. |
tenant.nav_links[].url |
string | The link's address (absolute https). |
tenant.logo |
object or nil | The tenant's logo, or nil without one. |
tenant.logo.url |
string | The logo's address; use it as an img src. |
tenant.logo.alt |
string | The logo's text alternative; empty when the logo is decorative. |
tenant.logo_dark |
object or nil | The logo for dark backgrounds, or nil without one. |
tenant.logo_dark.url |
string | The dark logo's address; use it as an img src. |
tenant.logo_dark.alt |
string | The dark logo's text alternative; empty when decorative. |
state |
object | Display facts about the page; which slots are required follows the state id, not these. |
state.status |
string | awaiting_card, card_saved, charging, not_paid, card_changed or another of the sign-up's statuses. |