ads
GET /v1/ads/plan
The organisation's Zinn® Ads plan, what it uses and what it allows.
Authentication
Send an API key as a bearer token. The key must carry the ads.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/ads/plan \
-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
Gated on ads.view. source is plan (a zinn_ads subscription, the org's own or an ancestor's), staff or none — with none no ad account can be connected until a plan is chosen (the Free plan is $0). connections.limit -1 is unlimited; connections.used counts every connection the plan pays for (the paying org and its client orgs). monthly_spend_usd is the managed ad spend a month the plan covers across all those accounts, in whole US dollars, including Extra-spend add-on blocks; managed_spend_usd is the sum of the monthly ceilings set now (null when a ceiling's currency has no stored FX rate). addons counts the Extra-accounts (+10) and Extra-spend (+$25k) blocks applied. overage.automatic is the Agency plan: spend above the allowance is billed on the renewal at +$99 per extra $25k (overage.blocks, overage.usd_minor). click_shield.source is hosting when a Zinn® hosting plan includes it free, addon when bought, plan, staff or none. Plans are bought through the cart like any plan (listInAppCatalogPlans, product_line=zinn_ads).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | Yes | — |
source | string<plan, staff, none> | Yes | — |
plan_code | object | Yes | — |
plan_name | object | Yes | — |
interval | object | Yes | — |
connections | object | Yes | — |
monthly_spend_usd | integer | Yes | — |
managed_spend_usd | object | Yes | — |
addons | object | Yes | — |
overage | object | Yes | — |
features | object | Yes | — |
click_shield | object | Yes | — |
in_good_standing | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429