---
title: "List machine-payment credit top-up offers"
method: GET
path: "/api/v1/credits/topup"
tags: ["Credits"]
---

# List machine-payment credit top-up offers

`GET /api/v1/credits/topup`

## Request

- Base URL: `https://www.vidguy.ai`
- URL: `https://www.vidguy.ai/api/v1/credits/topup`
- Auth: HTTP bearer

Fixed top-up sizes with USD prices and the URL to POST for each, plus which payment rails this deployment accepts. Pass `required` (credits a blocked action needs) to get the smallest size that covers it.

## Query parameters

- `required` integer
- `balance` integer, nullable

## Response `200`

Offers and rails.

- CreditsTopupOffersResponse
  - `enabled` boolean, required
  - `rails` CreditsTopupRails, required
    - `x402` boolean, required
    - `mpp` boolean, required
  - `usdPerCredit` number, required
  - `offers` CreditsTopupOffer[], required
    - `credits` integer, required
    - `priceUsd` string, required
    - `url` string, required
  - `suggestedCredits` integer, nullable, required
  - `how` string, required

## Other responses

- `401`: Missing or invalid API key.

---

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