extras

POST `/v1/pbn-boost/cancel`

Stop the account's PBN Performance Boost.

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

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 POST https://api.zinndigital.com/v1/pbn-boost/cancel \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

A paid boost stops renewing and keeps working until ends_at (the end of the paid month); nothing is refunded. A staff organization's boost ends at once. After it ends every PBN site returns to its plan's limits at the next converge. Refusal: pbn_boost_none. Requires billing.payment.manage.

Request body

Name	Type	Required	What it is
`org_id`	`string`	No	—

Response

Name	Type	Required	What it is
`purchase_id`	`string`	Yes	—
`extra_code`	`string`	Yes	—
`ends_at`	`object`	Yes	The last day the boost works (the end of the paid month); after it the site drops back to its plan's limits at the next converge.

Errors this endpoint can return

401 · 403 · 422