List tenant products

curl --request GET \
  --url https://api.simplepay.mx/v1/products \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.simplepay.mx/v1/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.simplepay.mx/v1/products"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "object": "<unknown>",
  "url": "<unknown>",
  "has_more": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "<unknown>",
      "active": true,
      "created": 123,
      "default_price": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "images": [
        "<string>"
      ],
      "marketing_features": [
        {
          "name": "<string>"
        }
      ],
      "livemode": true,
      "metadata": {},
      "name": "<string>",
      "package_dimensions": {},
      "shippable": true,
      "statement_descriptor": "<string>",
      "tax_code": "<string>",
      "tax_details": {
        "performance_location": "<string>",
        "tax_code": "<string>"
      },
      "unit_label": "<string>",
      "updated": 123,
      "url": "<string>",
      "cms": {
        "categories": [
          {
            "active": true,
            "description": "<string>",
            "fallback": {},
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "object": "<unknown>",
            "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "slug": "<string>",
            "sortOrder": 123,
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "primary_category": {
          "active": true,
          "description": "<string>",
          "fallback": {},
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "object": "<unknown>",
          "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "sortOrder": 123,
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "content": {},
        "bookable": {
          "object": "<unknown>",
          "id": "<string>",
          "slug": "<string>",
          "duration_minutes": 2,
          "time_zone": "<string>",
          "slot_interval_minutes": 2,
          "payment_required": true,
          "summary": {
            "occurrences_count": 1,
            "tiers_count": 1,
            "starts_at": "2023-11-07T05:31:56Z",
            "ends_at": "2023-11-07T05:31:56Z"
          },
          "urls": {
            "offers": "<string>",
            "availability": "<string>",
            "holds": "<string>",
            "bookings": "<string>",
            "slots": "<string>"
          }
        }
      }
    }
  ]
}

GET

https://api.simplepay.mx

products

List tenant products

curl --request GET \
  --url https://api.simplepay.mx/v1/products \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.simplepay.mx/v1/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.simplepay.mx/v1/products"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "object": "<unknown>",
  "url": "<unknown>",
  "has_more": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "<unknown>",
      "active": true,
      "created": 123,
      "default_price": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "images": [
        "<string>"
      ],
      "marketing_features": [
        {
          "name": "<string>"
        }
      ],
      "livemode": true,
      "metadata": {},
      "name": "<string>",
      "package_dimensions": {},
      "shippable": true,
      "statement_descriptor": "<string>",
      "tax_code": "<string>",
      "tax_details": {
        "performance_location": "<string>",
        "tax_code": "<string>"
      },
      "unit_label": "<string>",
      "updated": 123,
      "url": "<string>",
      "cms": {
        "categories": [
          {
            "active": true,
            "description": "<string>",
            "fallback": {},
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "object": "<unknown>",
            "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "slug": "<string>",
            "sortOrder": 123,
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "primary_category": {
          "active": true,
          "description": "<string>",
          "fallback": {},
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "object": "<unknown>",
          "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "sortOrder": 123,
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "content": {},
        "bookable": {
          "object": "<unknown>",
          "id": "<string>",
          "slug": "<string>",
          "duration_minutes": 2,
          "time_zone": "<string>",
          "slot_interval_minutes": 2,
          "payment_required": true,
          "summary": {
            "occurrences_count": 1,
            "tiers_count": 1,
            "starts_at": "2023-11-07T05:31:56Z",
            "ends_at": "2023-11-07T05:31:56Z"
          },
          "urls": {
            "offers": "<string>",
            "availability": "<string>",
            "holds": "<string>",
            "bookings": "<string>",
            "slots": "<string>"
          }
        }
      }
    }
  ]
}

Uso

Usalo para administrar productos del tenant, ofertas, disponibilidad o inventario empresarial asociado al catalogo SimplePay.

Antes de llamar

Tema	Detalle
Metodo	`GET`
Ruta	`/v1/products`
Auth	Bearer API key del ambiente correcto.
Scope	`products:read`
Idempotencia	No aplica para lecturas.
Guia relacionada	API Reference overview

Patron recomendado

Ejecuta esta lectura desde backend cuando incluya datos privados del tenant.
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/products" \
  -H "Authorization: Bearer $SIMPLEPAY_API_KEY"

Errores a manejar

400 indica payload, parametros o estado invalido.
401 o 403 indican API key, ambiente o scopes incorrectos.
429 y 5xx se 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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

zh,

zh-hans

limit

integer

Required range: 1 <= x <= 100

cursor

string

include_archived

boolean

expand[]

enum<string>[]

Available options:

data.default_price

Response

200 - application/json

Tenant products

object

any

url

any

has_more

boolean

data

object[]

Hide child attributes

data.id

string<uuid>

data.object

any

data.active

boolean

data.created

integer

data.default_price

data.description

string | null

data.images

string[]

data.marketing_features

object[]

Hide child attributes

data.marketing_features.name

string | null

data.livemode

boolean

data.metadata

object

data.name

string

data.package_dimensions

object | null

data.shippable

boolean | null

data.statement_descriptor

string | null

data.tax_code

string | null

data.tax_details

object | null

Hide child attributes

data.tax_details.performance_location

string | null

data.tax_details.tax_code

string

data.unit_label

string | null

data.updated

integer

data.url

string | null

data.cms

object

Hide child attributes

data.cms.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.cms.categories

object[]

Hide child attributes

data.cms.categories.active

boolean

data.cms.categories.description

string

data.cms.categories.fallback

object

Hide child attributes

data.cms.categories.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.cms.categories.id

string<uuid>

data.cms.categories.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.cms.categories.name

string

data.cms.categories.object

any

data.cms.categories.parentCategoryId

string<uuid>

data.cms.categories.slug

string

data.cms.categories.sortOrder

integer

data.cms.categories.updatedAt

string<date-time>

data.cms.primary_category

object | null

Hide child attributes

data.cms.primary_category.active

boolean

data.cms.primary_category.description

string

data.cms.primary_category.fallback

object

Hide child attributes

data.cms.primary_category.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.cms.primary_category.id

string<uuid>

data.cms.primary_category.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.cms.primary_category.name

string

data.cms.primary_category.object

any

data.cms.primary_category.parentCategoryId

string<uuid>

data.cms.primary_category.slug

string

data.cms.primary_category.sortOrder

integer

data.cms.primary_category.updatedAt

string<date-time>

data.cms.content

object

CMS-only content that is not duplicated from the SimplePay Product object.

data.cms.bookable

object | null

Hide child attributes

data.cms.bookable.object

any

data.cms.bookable.id

string

Pattern: ^evt_

data.cms.bookable.slug

string

data.cms.bookable.kind

enum<string>

Available options:

appointment,

class,

scheduled_offer,

experience,

rental,

service,

date_range,

ticketed_event,

hospitality

data.cms.bookable.inventory_mode

enum<string>

Available options:

capacity_pool,

date_range,

instant,

seated,

unit_assignment,

seat_map,

request_to_book

data.cms.bookable.duration_minutes

integer

Required range: x >= 1

data.cms.bookable.time_zone

string

data.cms.bookable.slot_interval_minutes

integer

Required range: x >= 1

data.cms.bookable.payment_required

boolean

data.cms.bookable.summary

object

Hide child attributes

data.cms.bookable.summary.occurrences_count

integer

Required range: x >= 0

data.cms.bookable.summary.tiers_count

integer

Required range: x >= 0

data.cms.bookable.summary.availability_status

enum<string>

Available options:

available,

limited,

request_to_book,

sold_out,

unavailable

data.cms.bookable.summary.starts_at

string<date-time> | null

data.cms.bookable.summary.ends_at

string<date-time> | null

data.cms.bookable.urls

object

Hide child attributes

data.cms.bookable.urls.offers

string

data.cms.bookable.urls.availability

string

data.cms.bookable.urls.holds

string

data.cms.bookable.urls.bookings

string

data.cms.bookable.urls.slots

string

Last modified on June 21, 2026

Evaluate a proposed payment against the tenant's effective SimplePay payment policy Create a tenant product

Overview

Checkout

Payment Links

Refunds

Payment Policy

Products

Catalog

Customer Hub

Bookable: setup

Bookable: resources

Bookable: disponibilidad

Bookable: event types

Bookable: holds y bookings

Webhooks y eventos

Meta

List tenant products

Uso

Antes de llamar

Patron recomendado

Ejemplo minimo

Errores a manejar

Contrato OpenAPI

Authorizations

Query Parameters

Response

​Uso

​Antes de llamar

​Patron recomendado

​Ejemplo minimo

​Errores a manejar

​Contrato OpenAPI

Authorizations

Query Parameters

Response

Uso

Antes de llamar

Patron recomendado

Ejemplo minimo

Errores a manejar

Contrato OpenAPI