compute

POST `/v1/compute/trial-credit`

Claim the one-time Cloud trial credit.

Authentication

Send an API key as a bearer token. The endpoint checks billing.payment.manage, sites.view; 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/compute/trial-credit \
  -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

For a new customer with a confirmed e-mail address and a verified card on file. Nothing is charged. One per person, card and browser across accounts; refused with 422 and the reason otherwise.

Request body

Name	Type	Required	What it is
`org_id`	`object`	No	Required only when the caller belongs to more than one organisation.

Response

Name	Type	Required	What it is
`eligible`	`boolean`	Yes	—
`reason`	`string<, already_granted, no_policy, not_customer, reseller_client, not_in_good_standing, email_not_verified, no_card, paid_before, used_elsewhere, card_used_elsewhere, no_fx_rate>`	Yes	Why the credit cannot be claimed, empty when it can. email_not_verified and no_card are steps the customer can take.
`claimed`	`boolean`	Yes	—
`offer_minor`	`object`	Yes	The credit a claim gives now, minor units of currency.
`remaining_minor`	`object`	Yes	What is left of a claimed credit, minor units of currency.
`currency`	`string`	Yes	—
`used_up`	`boolean`	Yes	—

Errors this endpoint can return

401 · 403 · 422 · 429