seo-connect
GET /v1/seo-connection/account
The site's credit position — balance, 30-day forecast, holds, prices.
Authentication
This endpoint does not take an API key. It takes its own credential, issued to the plugin or service that calls it, as a bearer token; see the description above.
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/seo-connection/account \
-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
What the plugin's Account screen shows: the organization's Zinn® credit balance, what the site's scheduled pay-per-use work will cost over the next 30 days (and the day the balance runs out at that rate), the products held for want of credit, the price of each unit, the packs on sale, the auto top-up settings, this site's monthly limit and what it has spent this month, and the page to buy credits on (open it in a new tab). Answers for an account in bad standing too, so the site can say why its tools stopped.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | Yes | — |
currency | string<USD> | Yes | — |
balance_micros | integer | Yes | Zinn® credit balance |
is_low | boolean | Yes | — |
is_empty | boolean | Yes | — |
forecast | object | Yes | — |
holds | object | Yes | — |
unit_prices | object[] | Yes | — |
site | object | Yes | — |
settings | object | Yes | The organization's auto top-up settings (as getAiCredits returns them). |
packs | object[] | Yes | The Zinn® credit packs on sale (as getAiCredits returns them). |
buy_url | string | Yes | Where "Buy credits" opens — in a new tab. It names the organisation the site spends from (?org=<org_id>), so the app opens on that account even when the person last used another… |
Errors this endpoint can return
401 · 403