> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xquik.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Check X API credit top-up payment status API
> Poll a credit checkout session for processing, paid, expired, or failed status before starting tweet, follower, monitor, or write requests. Polling is free.
```json theme={null}
{
"amount_dollars": 25,
"credits": "166666",
"status": "paid"
}
```
```json theme={null}
{
"error": "invalid_input",
"message": "Invalid input. Check the request body."
}
```
```json theme={null}
{
"error": "unauthenticated",
"message": "Authentication required. Provide a valid API key or bearer token."
}
```
```json theme={null}
{
"error": "not_found",
"message": "Resource not found."
}
```
```json theme={null}
{
"error": "rate_limit_exceeded",
"message": "Too many requests. Try again later.",
"retryAfter": 60
}
```
For the complete documentation index, see llms.txt.
**Free.** This endpoint does not consume credits.
Use this endpoint after creating a standard [top-up checkout](/api-reference/credits/topup). Pass the checkout session ID for that top-up to check whether payment is complete.
```bash cURL theme={null}
curl "https://xquik.com/api/v1/credits/topup/status?session_id=checkout_session_id" \
-H "x-api-key: xq_YOUR_KEY_HERE" | jq
```
```javascript Node.js theme={null}
const sessionId = "checkout_session_id";
const response = await fetch(
`https://xquik.com/api/v1/credits/topup/status?session_id=${encodeURIComponent(sessionId)}`,
{ headers: { "x-api-key": "xq_YOUR_KEY_HERE" } },
);
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.get(
"https://xquik.com/api/v1/credits/topup/status",
headers={"x-api-key": "xq_YOUR_KEY_HERE"},
params={"session_id": "checkout_session_id"},
)
data = response.json()
print(data)
```
```go Go theme={null}
package main
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
)
func main() {
endpoint, err := url.Parse("https://xquik.com/api/v1/credits/topup/status")
if err != nil {
panic(err)
}
query := endpoint.Query()
query.Set("session_id", "checkout_session_id")
endpoint.RawQuery = query.Encode()
req, err := http.NewRequest("GET", endpoint.String(), nil)
if err != nil {
panic(err)
}
req.Header.Set("x-api-key", "xq_YOUR_KEY_HERE")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
panic(err)
}
fmt.Println(data)
}
```
## Hold queued API work until checkout is paid
Store the checkout session ID when creating a standard top-up. Associate it
with the intended tweet, follower, reply, monitor, or write workload. Never
substitute a session from another account or purchase.
Poll this endpoint before you start work that needs the credits. Act on the
returned status:
* `processing` keeps the workload paused.
* `paid` allows a fresh credit-balance check.
* `failed` requires a new checkout.
* `expired` requires a new checkout.
Do not start work from `amount_dollars` or `credits` alone. Only `paid`
confirms that Xquik granted credits. Then call
[Get Credits](/api-reference/credits/get). Compare the balance with the planned
request cost.
Limit polls while the status is `processing`. Wait between requests and honor
`Retry-After` after rate limiting. Faster polling does not speed up
payment.
Store the last observed status and check time with the session ID. This lets
another worker resume polling without creating a second purchase.
`failed` and `expired` are final. Stop polling that session. Create a new checkout only
after the user or approved billing workflow requests it.
When `paid` appears, start only the workload tied to that checkout. Keep
unrelated queues behind their own credit and approval checks. One top-up
then cannot start unrelated work.
## Headers
Your API key. Session cookie authentication is also supported.
## Query parameters
Checkout session ID for the top-up checkout.
## Response
### 200 Paid
Payment succeeded. Xquik added credits to the account.
Always `"paid"`.
Dollar amount requested for the top-up.
Credit amount granted as a Bigint string.
```json theme={null}
{
"amount_dollars": 25,
"credits": "166666",
"status": "paid"
}
```
### 200 Processing
Payment has not reached a final state yet. Poll again later.
Always `"processing"`.
Dollar amount requested for the top-up, when available.
Pending credit amount as a Bigint string, when available.
```json theme={null}
{
"amount_dollars": 25,
"credits": "166666",
"status": "processing"
}
```
### 200 Failed
Payment failed. Create a new top-up checkout before retrying payment.
Always `"failed"`.
```json theme={null}
{
"status": "failed"
}
```
### 200 Expired
The checkout session expired before payment completed.
Always `"expired"`.
```json theme={null}
{
"status": "expired"
}
```
### 400 Invalid input
```json theme={null}
{ "error": "invalid_input" }
```
The `session_id` query parameter is missing.
### 401 Unauthenticated
```json theme={null}
{ "error": "unauthenticated" }
```
Missing or invalid API key.
### 404 Not found
```json theme={null}
{ "error": "not_found" }
```
No top-up checkout exists for that session ID on this account.
### 429 Rate limited
```json theme={null}
{
"error": "rate_limit_exceeded",
"message": "Too many requests. Try again later.",
"retryAfter": 1
}
```
Too many requests. Wait for the `Retry-After` header before retrying.
**Related.** [Top Up Credits](/api-reference/credits/topup) · [Quick Top-Up](/api-reference/credits/quick-topup) · [Get Credits](/api-reference/credits/get) · [Billing Guide](/guides/billing)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.