extras
POST /v1/pbn-boost
Choose or change the account's PBN Performance Boost level.
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 \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "level": <integer> }'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
Buys the level through the ordinary add-on purchase (charge, tax, invoice), priced max(minimum, per site x sites) on today's PBN site count. Choosing another level replaces the current one and credits its unused days to the account. Staff organizations are not charged. Refusals (details[].code): pbn_boost_unknown_level, pbn_boost_no_pbn_line, pbn_boost_same_level. PAYMENT_METHOD_REQUIRED means no payment method is on file and nothing was charged. Paying in place (Q225). When nothing on file can settle it, the purchase is placed (order pending_payment, purchase awaiting_payment) and NOT charged: the 422 PAYMENT_METHOD_REQUIRED envelope carries error.payment — the order to settle on-session with payOrder / openPayPalOrder / openOrderCustomerAction, exactly as the basket checkout does. Paying it completes the purchase and starts fulfilment as a stored-card buy would; no order is ever recorded as failed for money nobody was asked for. Repeating the request within 24 hours resumes the SAME order (and charges it, if a payment method has been added since) rather than placing another. Requires billing.payment.manage.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
level | integer | Yes | — |
org_id | string | No | — |
currency | string | No | — |
gateway | string | No | The payment rail the customer picked. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
purchase_id | string | Yes | — |
level | integer | Yes | — |
extra_code | string | Yes | — |
status | string | Yes | — |
amount_minor | integer | Yes | — |
currency | string | Yes | — |
Errors this endpoint can return
401 · 403 · 422