catalog

GET /v1/catalog/app/plans

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

All catalog endpoints

All developer docs →

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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. A reseller's client is quoted the reseller's prices — the reseller's own price for the plan where they set one, otherwise list plus their default markup — which is exactly what the cart charges. The public listCatalogPlans never does this: it is anonymous and shared-cached. The dashboard's checkout reads this endpoint for that reason.

Parameters

NameTypeRequiredWhat it is
product_line (query)stringNoRestrict to one product line by its code (e.g. mail). Unknown code → empty list.
currency (query)stringNoNarrow each plan's prices array to a single ISO 4217 currency, exactly as on listCatalogPlans, and publish each plan's per-term prices in terms. Omitted, every currency is…

Response

NameTypeRequiredWhat it is
dataCatalogPlan[]Yes—

Errors this endpoint can return

401 · 422 · 429