Retrieve a booking blackout period
curl --request GET \
--url https://api.simplepay.mx/v1/bookable-payments/blackouts/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.simplepay.mx/v1/bookable-payments/blackouts/{id}', 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/blackouts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"active": true,
"endsAt": "2023-11-07T05:31:56Z",
"eventTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"object": "<unknown>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startsAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Retrieve a booking blackout period
Referencia detallada para GET /v1/bookable-payments/blackouts/.
GET
https://api.simplepay.mx
/
v1
/
bookable-payments
/
blackouts
/
{id}
Retrieve a booking blackout period
curl --request GET \
--url https://api.simplepay.mx/v1/bookable-payments/blackouts/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.simplepay.mx/v1/bookable-payments/blackouts/{id}', 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/blackouts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"active": true,
"endsAt": "2023-11-07T05:31:56Z",
"eventTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"object": "<unknown>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startsAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}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/blackouts/{id} |
| Auth | Bearer API key del ambiente correcto. |
| Scope | availability: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/blackouts/id_123" \
-H "Authorization: Bearer $SIMPLEPAY_API_KEY"
Errores a manejar
400indica payload, parametros o estado invalido.401o403indican API key, ambiente o scopes incorrectos.404significa que el recurso no existe para ese tenant o ambiente.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.
Path Parameters
Last modified on June 21, 2026
⌘I