X API subscription checkout & billing page

{
  "chargedCurrency": "EUR",
  "url": "https://xquik.com/billing/session",
  "status": "checkout_created",
  "message": "Billing session created"
}

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

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

{
  "error": "api_key_paused",
  "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again."
}

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

POST

X API subscription checkout & billing page

curl --request POST \
  --url https://xquik.com/api/v1/subscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tier": "<string>",
  "currency": "<string>"
}
'

import requests

url = "https://xquik.com/api/v1/subscribe"

payload = {
    "tier": "<string>",
    "currency": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tier: '<string>', currency: '<string>'})
};

fetch('https://xquik.com/api/v1/subscribe', 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/subscribe"

	payload := strings.NewReader("{\n  \"tier\": \"<string>\",\n  \"currency\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "url": "<string>",
  "message": "<string>",
  "status": "<string>",
  "chargedCurrency": "<string>"
}

Free. This endpoint does not consume credits.

Returns a checkout URL for new subscribers. An existing subscriber gets the dashboard billing page, where the user signs in to manage billing. An API key never opens a billing portal session.

curl -X POST https://xquik.com/api/v1/subscribe \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

const response = await fetch("https://xquik.com/api/v1/subscribe", {
  method: "POST",
  headers: {
    "x-api-key": "xq_YOUR_KEY_HERE",
  },
});
const data = await response.json();
// Redirect user to data.url

import requests

response = requests.post(
    "https://xquik.com/api/v1/subscribe",
    headers={"x-api-key": "xq_YOUR_KEY_HERE"},
)
data = response.json()
# Redirect user to data["url"]

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    req, err := http.NewRequest("POST", "https://xquik.com/api/v1/subscribe", 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)
}

Create an X API subscription checkout

Call POST /subscribe after an authenticated user confirms a billing action. The request creates a hosted URL. It never completes payment automatically. Use this route for 3 account states.

Account state	Response status	Returned destination
No active subscription	`checkout_created`	Hosted subscription checkout
Active or trialing subscription	`already_subscribed`	Dashboard billing page, after sign-in
Past-due or incomplete subscription	`payment_issue`	Dashboard billing page, to fix the payment

Always route by status. Do not infer the destination from the URL hostname. Use only the URL returned by the current response. This endpoint does not quote current Twitter API pricing or X API pricing. Review the live Xquik pricing page before checkout. The pricing page lists the current tiers, credits, and terms.

Choose a subscription tier

Send tier only when the user selected a specific Xquik plan.

Tier value	Checkout behavior
`starter`	Pre-select Starter.
`pro`	Pre-select Pro.
`business`	Pre-select Business.
Omitted	Let the user choose on the hosted checkout.

The field pre-selects a tier. It does not activate that tier by itself. Send only the documented enum values.

Pay in the user’s currency

Send currency to charge in the user’s currency. The default is USD. Xquik accepts USD, EUR, GBP, TRY, JPY, CNY, KRW, CAD, AUD, and MXN. Lowercase codes work too. An unknown code returns 400. Xquik converts the USD plan price at the latest daily ECB rate. Each renewal charges the same amount before tax. An account that already pays in USD gets a USD checkout. With rates over 3 ECB working days old, the checkout charges USD. Read chargedCurrency to see the currency the checkout charges.

Complete a safe billing handoff

Show the current plan and credit terms before confirmation.
Call this endpoint once for the confirmed action.
Check the HTTP status before reading url.
Send the user to the returned hosted URL.
Keep the billing URL out of logs and analytics.
Recheck GET /account after the user returns.

Read plan to confirm subscription state. Read creditInfo.balance before tweet search, follower exports, writes, or monitor work. Subscriptions are not the only funding path. A funded pay-as-you-go account can continue eligible work while plan is inactive.

Handle checkout retries

The service can reuse a matching open checkout. Use the latest returned URL. A different tier or currency can replace an older open checkout. Do not call this endpoint from a timer or an automatic retry loop. For 429, wait for Retry-After. For 401, replace the credential first.

Headers

string

required

Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.

Body

string

Pre-select starter, pro, or business. Omit the body when the user should choose on the hosted checkout.

string

default:"USD"

Currency to pay in, such as EUR. Lowercase codes work too.

Response

200 OK

string

Checkout URL for new subscribers, or the dashboard billing page for existing subscribers. Send the user to this URL.

string

Human-readable message describing the action taken.

string

The status is already_subscribed, checkout_created, or payment_issue.

string

Currency the checkout charges. Only a checkout_created answer has it.

{
  "chargedCurrency": "EUR",
  "url": "https://xquik.com/billing/checkout/session",
  "message": "Complete checkout at the URL below to start your subscription.",
  "status": "checkout_created"
}

400 Invalid input

{
  "error": "invalid_input",
  "message": "currency must be 1 of USD, EUR, GBP, TRY, JPY, CNY, KRW, CAD, AUD, MXN"
}

Send a listed currency code, or omit currency to pay in USD.

401 Unauthenticated

{ "error": "unauthenticated", "message": "Missing or invalid API key" }

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. Get Account to check current subscription status and usage.

{
  "chargedCurrency": "EUR",
  "url": "https://xquik.com/billing/session",
  "status": "checkout_created",
  "message": "Billing session created"
}

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

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

{
  "error": "api_key_paused",
  "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again."
}

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

X API subscription checkout & billing page

curl --request POST \
  --url https://xquik.com/api/v1/subscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tier": "<string>",
  "currency": "<string>"
}
'

import requests

url = "https://xquik.com/api/v1/subscribe"

payload = {
    "tier": "<string>",
    "currency": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tier: '<string>', currency: '<string>'})
};

fetch('https://xquik.com/api/v1/subscribe', 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/subscribe"

	payload := strings.NewReader("{\n  \"tier\": \"<string>\",\n  \"currency\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "url": "<string>",
  "message": "<string>",
  "status": "<string>",
  "chargedCurrency": "<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

X API subscription checkout & billing page

Create an X API subscription checkout

Choose a subscription tier

Pay in the user’s currency

Complete a safe billing handoff

Handle checkout retries

Headers

Body

Response

200 OK

400 Invalid input

401 Unauthenticated

429 Rate limited

​Create an X API subscription checkout

​Choose a subscription tier

​Pay in the user’s currency

​Complete a safe billing handoff

​Handle checkout retries

​Headers

​Body

​Response

​200 OK

​400 Invalid input

​401 Unauthenticated

​429 Rate limited

Create an X API subscription checkout

Choose a subscription tier

Pay in the user’s currency

Complete a safe billing handoff

Handle checkout retries

Headers

Body

Response

200 OK

400 Invalid input

401 Unauthenticated

429 Rate limited