catalog

GET /v1/catalog/app/plans

List the plans a signed-in customer may buy, including unadvertised ones.

Todos os endpoints de catalog

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/catalog/app/plans \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Identical to `listCatalogPlans` — same shape, same multi-currency `prices` array, same `plan_version_id` purchase path — plus the plans on **in-app-only** lines. This is the endpoint the dashboard reads to offer email on an external domain. The purchase path is unchanged: `POST /v1/carts` → `POST /v1/carts/{cartId}/lines` with `{kind: hosting_plan, plan_version_id, metadata: {interval}}` → checkout. ⛔ The in-app-only exclusion on the public endpoint is applied **even when `product_line` names the hidden line** — naming a thing is not authorisation to see it, and that parameter arrives from an untrusted query string.

Parâmetros

NomeTipoObrigatórioO que é
product_line (query)stringNãoRestrict to one product line by its code (e.g. `mail`). Unknown code → empty list.

Resposta

NomeTipoObrigatórioO que é
dataCatalogPlan[]Sim

Erros que este endpoint pode retornar

401 · 422 · 429