---
title: "POST /api/v1/credits/topup"
method: POST
path: "/api/v1/credits/topup"
tags: ["Subscribe"]
---

# POST /api/v1/credits/topup

`POST /api/v1/credits/topup`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/credits/topup`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Create a hosted checkout only after the user confirms. The request never completes payment or adds credits.

## Request body

- object
  - `dollars` integer, required: Amount to top up in US dollars. Minimum 10.
  - `locale` string: Optional site language for Stripe's return page. An unsupported language uses en, the default.

## Response `200`

Top-up checkouts

- object
  - `redirect_url` string, uri, required: Stable Xquik redirect URL for the active checkout.
  - `url` string, uri, required: Same stable Xquik redirect URL as redirect_url. The response never exposes the hosted checkout URL.

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 10 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …6 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/credits/topup/post.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xquik-dev/apis/xquik-api/revisions/45942c75fdc2?raw)