Inspect Bookable Payments scheduling integration readiness
curl --request GET \
--url https://api.simplepay.mx/v1/bookable-payments/preflight \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.simplepay.mx/v1/bookable-payments/preflight', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.simplepay.mx/v1/bookable-payments/preflight"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"blueprint": {
"default_capacity": 2,
"default_duration_minutes": 2,
"default_resource_kind": "<string>",
"default_schedule": {
"end_time": "<string>",
"start_time": "<string>",
"time_zone": "<string>",
"weekdays": [
3
]
},
"default_slot_interval_minutes": 2,
"event_kind": "<string>",
"id": "<string>",
"inventory_mode": "<string>",
"label": "<string>",
"primitives": [
"<string>"
],
"resource_assignment_mode": "<string>",
"spanish_label": "<string>",
"steps": [
{
"estimated_minutes": 1,
"id": "<string>",
"label": "<string>",
"phase": "<string>",
"readiness_keys": [
"<string>"
],
"required_for_go_live": true,
"required_routes": [
"<string>"
],
"required_scopes": [
"<string>"
],
"tenant_tables": [
"<string>"
]
}
],
"webhook_events": [
"<string>"
]
},
"counts": {
"active_bookable_products": 1,
"active_customer_profiles": 1,
"active_event_types": 1,
"active_resources": 1,
"active_schedule_rules": 1,
"active_schedules": 1,
"checkout_bookings": 1,
"priced_event_types": 1,
"slot_ready_event_types": 1,
"webhook_endpoints": 1
},
"object": "<unknown>",
"plan": {
"estimated_minutes_remaining": 1,
"missing": [
"<string>"
],
"next_step": {
"estimated_minutes": 1,
"id": "<string>",
"label": "<string>",
"phase": "<string>",
"readiness_keys": [
"<string>"
],
"required_for_go_live": true,
"required_routes": [
"<string>"
],
"required_scopes": [
"<string>"
],
"tenant_tables": [
"<string>"
],
"blocking": true
},
"ready": true,
"recommended": [
"<string>"
],
"required_scopes": [
"<string>"
],
"steps": [
{
"estimated_minutes": 1,
"id": "<string>",
"label": "<string>",
"phase": "<string>",
"readiness_keys": [
"<string>"
],
"required_for_go_live": true,
"required_routes": [
"<string>"
],
"required_scopes": [
"<string>"
],
"tenant_tables": [
"<string>"
],
"blocking": true
}
]
},
"product": {
"key": "<unknown>",
"name": "<string>",
"spanish_name": "<string>"
},
"readiness": {},
"tenant_env": "<string>"
}Inspect Bookable Payments scheduling integration readiness
Referencia detallada para GET /v1/bookable-payments/preflight.
GET
https://api.simplepay.mx
/
v1
/
bookable-payments
/
preflight
Inspect Bookable Payments scheduling integration readiness
curl --request GET \
--url https://api.simplepay.mx/v1/bookable-payments/preflight \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.simplepay.mx/v1/bookable-payments/preflight', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.simplepay.mx/v1/bookable-payments/preflight"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"blueprint": {
"default_capacity": 2,
"default_duration_minutes": 2,
"default_resource_kind": "<string>",
"default_schedule": {
"end_time": "<string>",
"start_time": "<string>",
"time_zone": "<string>",
"weekdays": [
3
]
},
"default_slot_interval_minutes": 2,
"event_kind": "<string>",
"id": "<string>",
"inventory_mode": "<string>",
"label": "<string>",
"primitives": [
"<string>"
],
"resource_assignment_mode": "<string>",
"spanish_label": "<string>",
"steps": [
{
"estimated_minutes": 1,
"id": "<string>",
"label": "<string>",
"phase": "<string>",
"readiness_keys": [
"<string>"
],
"required_for_go_live": true,
"required_routes": [
"<string>"
],
"required_scopes": [
"<string>"
],
"tenant_tables": [
"<string>"
]
}
],
"webhook_events": [
"<string>"
]
},
"counts": {
"active_bookable_products": 1,
"active_customer_profiles": 1,
"active_event_types": 1,
"active_resources": 1,
"active_schedule_rules": 1,
"active_schedules": 1,
"checkout_bookings": 1,
"priced_event_types": 1,
"slot_ready_event_types": 1,
"webhook_endpoints": 1
},
"object": "<unknown>",
"plan": {
"estimated_minutes_remaining": 1,
"missing": [
"<string>"
],
"next_step": {
"estimated_minutes": 1,
"id": "<string>",
"label": "<string>",
"phase": "<string>",
"readiness_keys": [
"<string>"
],
"required_for_go_live": true,
"required_routes": [
"<string>"
],
"required_scopes": [
"<string>"
],
"tenant_tables": [
"<string>"
],
"blocking": true
},
"ready": true,
"recommended": [
"<string>"
],
"required_scopes": [
"<string>"
],
"steps": [
{
"estimated_minutes": 1,
"id": "<string>",
"label": "<string>",
"phase": "<string>",
"readiness_keys": [
"<string>"
],
"required_for_go_live": true,
"required_routes": [
"<string>"
],
"required_scopes": [
"<string>"
],
"tenant_tables": [
"<string>"
],
"blocking": true
}
]
},
"product": {
"key": "<unknown>",
"name": "<string>",
"spanish_name": "<string>"
},
"readiness": {},
"tenant_env": "<string>"
}Uso
Usalo dentro de Bookable Payments para modelar inventario reservado, calcular disponibilidad, crear holds, convertirlos en checkout y confirmar bookings.Antes de llamar
| Tema | Detalle |
|---|---|
| Metodo | GET |
| Ruta | /v1/bookable-payments/preflight |
| Auth | Bearer API key del ambiente correcto. |
| Scope | products:read |
| Idempotencia | No aplica para lecturas. |
| Guia relacionada | Bookable Payments |
Patron recomendado
- Ejecuta esta lectura desde backend cuando incluya datos privados del tenant.
- Confirma inventario final con
booking.confirmedo una lectura de booking, no solo con una URL de retorno. - Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.
Ejemplo minimo
terminal
curl -sS "https://api.simplepay.mx/v1/bookable-payments/preflight" \
-H "Authorization: Bearer $SIMPLEPAY_API_KEY"
Errores a manejar
400indica payload, parametros o estado invalido.401o403indican API key, ambiente o scopes incorrectos.429y5xxse pueden reintentar con backoff; en writes conserva la misma idempotency key.
Contrato OpenAPI
El playground, parametros, body y respuestas de abajo salen de/openapi.json. Si el contrato cambia, actualiza la spec y regenera esta pagina.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Available options:
appointment, class, scheduled_offer, experience, rental, service, date_range, tour Response
200 - application/json
Bookable Payments preflight readiness
Hide child attributes
Hide child attributes
Required range:
x >= 1Required range:
x >= 1Required range:
x >= 1Hide child attributes
Hide child attributes
Required range:
x >= 0Hide child attributes
Hide child attributes
Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Hide child attributes
Hide child attributes
Required range:
x >= 0Hide child attributes
Hide child attributes
Required range:
x >= 0Available options:
done, missing, recommended Hide child attributes
Hide child attributes
Required range:
x >= 0Available options:
done, missing, recommended Last modified on June 21, 2026
Get Bookable Payments integration primitives and blueprintsCreate a Bookable Payments scheduling setup preset
⌘I