Skip to main content
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

topUpId
string
required
The top-up ID returned when the top-up was created.

Response

topUp
object

Errors

StatuscodeMeaning
401UNAUTHORIZEDMissing or invalid token
403FORBIDDENMissing payments:read scope, or public_api_credits disabled
404NOT_FOUNDNo such top-up, or it belongs to another account (details: {resource: "credit-top-ups", topUpId})