catalog

GET /v1/catalog/app/addons

List the add-ons a hosting order can carry, priced in every currency we can.

All catalog endpoints

All developer docs →

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/addons \
  -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

Every add-on we sell (the same rows the cart and createPartnerHostingOrder accept): its code, name, summary, interval (one_off or monthly), how it is fulfilled, the product lines it is sold on (all_lines is true when it is sold on every line), and its price per currency in integer minor units. A currency we hold no exchange rate for is omitted from prices rather than listed at the USD figure. Pass currency to narrow prices to the one you sell in — take that entry, never the first. Signed-in, non-tenant data: every caller sees the same list.

Parameters

NameTypeRequiredWhat it is
product_line (query)stringNoOnly add-ons sold on this product line.
currency (query)stringNoNarrow each add-on's prices to one ISO 4217 currency.

Response

NameTypeRequiredWhat it is
dataCatalogAddon[]Yes—

Errors this endpoint can return

401 · 429