Endpoint credits

Given once, not every month

The welcome grant is a trial, not a smaller plan. It does not come back on the first of the month.

• The grant is made when the account is created, and it is the only one an account receives on its own. Accounts that were already on the free plan when credits launched received it too.
• When the credits are spent, a call to an endpoint above your plan returns 403 PLAN_REQUIRED, as it would without them. To keep using those endpoints, move to a plan that includes them: see Rate limits and plans.
• The team can give an account more credits, for a named list of endpoints or for everything up to a plan, and can set an end date. Ask through support if you have a use in mind.
• A grant can be withdrawn. Calls it already paid for stay spent.

What happens when you spend one

Nothing about the request changes. Call the endpoint as you would on a plan that includes it.

1. 1

   You call the endpoint

   Send the request exactly as you would on a plan that includes the endpoint.

2. 2

   The gate checks your plan

   If your plan includes the endpoint, nothing is spent. If it does not and the account holds a credit that covers it, one credit is spent and the call goes through.

3. 3

   It is served as that plan

   A detail call returns the full record, not the free plan's summary, with that plan's page depth. The response carries X-Endpoint-Credit: spent and is never stored in a shared cache.

4. 4

   Your limits still apply

   Credits widen which endpoints you can reach, not how much you can send. The call counts against your per-minute limit and daily cap like any other.

5. 5

   A failure is given back

   If the call fails, or answers 304 Not Modified to an If-None-Match, the credit is returned.

6. 6

   With none left, it is refused

   The call returns PLAN_REQUIRED, as it would without credits.

1HTTP/2 2002X-Endpoint-Credit: spent3X-Daily-Limit: 504X-Daily-Remaining: 415Cache-Control: private, no-store

1HTTP/2 4032{3  "success": false,4  "error": {5    "code": "FORBIDDEN",6    "reason": "PLAN_REQUIRED",7    "message": "This endpoint requires 'builder' tier or above. Your tier: 'explorer'"8  }9}

Checking your balance

Your balance is on the Usage page of your account whenever the account has credits. The same figures are in GET /v1/me/usage, under endpointCredits.

A credit call still counts against the limits in Rate limits and plans.