Twitter API billing: instant X API credit top-up

{
  "outcome": "charged",
  "balance": "1450",
  "credits": "1000"
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

POST

credits

quick-topup

Twitter API billing: instant X API credit top-up

curl --request POST \
  --url https://xquik.com/api/v1/credits/quick-topup \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "dollars": 123
}'

import requests

url = "https://xquik.com/api/v1/credits/quick-topup"

payload = { "dollars": 123 }
headers = {
    "Content-Type": "<content-type>",
    "x-api-key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', 'x-api-key': '<api-key>'},
  body: JSON.stringify({dollars: 123})
};

fetch('https://xquik.com/api/v1/credits/quick-topup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/credits/quick-topup"

	payload := strings.NewReader("{\n  \"dollars\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "outcome": "<string>",
  "balance": "<string>",
  "credits": "<string>",
  "clientSecret": "<string>"
}

Add API credits from the Xquik dashboard with a saved payment method.

Add API credits with a saved payment method

Use quick top-up after the dashboard confirms an amount from USD 10 through 500. This route requires a same-origin Xquik session. External integrations must use the hosted top-up endpoint. Read outcome before handling any other response field. charged means the credits and new balance are ready. requires_action means the client must complete payment authentication. declined means the saved method failed. no_payment_method means the account has no reusable payment method. Never print or persist clientSecret. Pass it directly to the payment confirmation flow. Log only the outcome, added credits, and resulting balance after a successful charge. Quick top-up differs from standard checkout status. The status route polls a hosted checkout session by session_id. This route returns its own immediate payment outcome for the saved payment method.

Free - does not consume credits

const response = await fetch("/api/v1/credits/quick-topup", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ dollars: 25 }),
});
const result = await response.json();

if (result.outcome === "charged") {
  window.location.reload();
} else if (result.outcome === "requires_action") {
  await confirmSavedPayment(result.clientSecret);
} else {
  window.location.assign("/account/subscription");
}

Credit top-up outcome	Response fields	Next action
Immediate charge	`outcome: "charged"`	Store `credits` and the updated `balance`.
Payment authentication	`outcome: "requires_action"`	Complete the billing confirmation flow.
Missing payment method	`outcome: "no_payment_method"`	Create a checkout top-up instead.
Declined payment method	`outcome: "declined"`	Ask for another payment method.
Added credits	`credits`	Treat the bigint value as a string.
Updated balance	`balance`	Gate the next tweet, follower, or monitor job.
Confirmation secret	`clientSecret`	Send it only to the billing confirmation flow.

Headers

string

required

Must be application/json.

Body

number

required

Amount in US dollars to charge. Minimum

10, maximum

500.

At USD 0.00015 per credit, a USD 25 quick top-up adds 166,666 credits, rounded down to whole credits. Only charged grants credits. Complete requires_action with clientSecret. Use hosted checkout for declined or no_payment_method.

Response

200 Charged

Payment succeeded immediately. Credits added to your balance.

string

Always "charged".

string

Updated credit balance after top-up (Bigint string).

string

Number of credits added (Bigint string).

{
  "outcome": "charged",
  "balance": "466666",
  "credits": "166666"
}

200 Requires action

Payment requires additional authentication (e.g., 3D Secure). Use the returned client secret with the billing confirmation flow to complete the payment.

string

Always "requires_action".

string

Payment client secret for completing the payment.

{
  "outcome": "requires_action",
  "clientSecret": "pi_3abc...secret_xyz"
}

200 No payment method

No saved payment method on file. Redirect the user to add one via the billing portal, or use the standard top-up endpoint instead.

string

Always "no_payment_method".

{
  "outcome": "no_payment_method"
}

200 Declined

The saved method failed. Open hosted checkout so the user can choose another.

string

Always "declined".

{
  "outcome": "declined"
}

400 Invalid input

{ "error": "Invalid input" }

The request body is missing a numeric dollars value or includes too many decimal places.

401 Unauthenticated

{ "error": "unauthenticated" }

Missing or invalid API key.

429 Rate limited

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

Too many requests. Wait for the Retry-After header before retrying.

Related. Top Up Credits · Get Top-Up Status · Get Credits · Billing Guide

{
  "outcome": "charged",
  "balance": "1450",
  "credits": "1000"
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

Twitter API billing: instant X API credit top-up

curl --request POST \
  --url https://xquik.com/api/v1/credits/quick-topup \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "dollars": 123
}'

import requests

url = "https://xquik.com/api/v1/credits/quick-topup"

payload = { "dollars": 123 }
headers = {
    "Content-Type": "<content-type>",
    "x-api-key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', 'x-api-key': '<api-key>'},
  body: JSON.stringify({dollars: 123})
};

fetch('https://xquik.com/api/v1/credits/quick-topup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/credits/quick-topup"

	payload := strings.NewReader("{\n  \"dollars\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "outcome": "<string>",
  "balance": "<string>",
  "credits": "<string>",
  "clientSecret": "<string>"
}

Overview

X API

X write

Trends

Radar

Account

API keys

Guest wallets

Credits

X accounts

Monitors

Events

Webhooks

Draws

Extractions

Compose

Drafts

Styles

Support

Twitter API billing: instant X API credit top-up

Add API credits with a saved payment method

Headers

Body

Response

200 Charged

200 Requires action

200 No payment method

200 Declined

400 Invalid input

401 Unauthenticated

429 Rate limited

​Add API credits with a saved payment method

​Headers

​Body

​Response

​200 Charged

​200 Requires action

​200 No payment method

​200 Declined

​400 Invalid input

​401 Unauthenticated

​429 Rate limited

Add API credits with a saved payment method

Headers

Body

Response

200 Charged

200 Requires action

200 No payment method

200 Declined

400 Invalid input

401 Unauthenticated

429 Rate limited