Credits
Get Credit Top-Up
Poll a credit top-up until the human has paid: PENDING, COMPLETED, EXPIRED, or CANCELED.
GET
Reads one top-up. Poll it after handing the
checkoutUrl to your human: PENDING means the checkout link has not been paid yet, COMPLETED means the credits are available (confirm with GET /credits).
A PENDING top-up past its expiresAt flips to EXPIRED the next time it is read — expired links cannot be paid; create a new top-up instead. Top-ups belonging to another account return 404.
Requirements: payments:read scope + the public_api_credits feature. Works pre-claim.
Request
The top-up ID returned when the top-up was created.
Response
Errors
| Status | code | Meaning |
|---|---|---|
401 | UNAUTHORIZED | Missing or invalid token |
403 | FORBIDDEN | Missing payments:read scope, or public_api_credits disabled |
404 | NOT_FOUND | No such top-up, or it belongs to another account (details: {resource: "credit-top-ups", topUpId}) |