---
title: "Get machine-readable top-up constraints"
method: GET
path: "/credits/me/topups/config"
tags: ["Widget"]
---

# Get machine-readable top-up constraints

`GET /credits/me/topups/config`

## Request

- Base URL: `https://api.paywithlocus.com/api`
- URL: `https://api.paywithlocus.com/api/credits/me/topups/config`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `X-Locus-Publishable-Key`

Returns the top-up amount constraints that apply to the calling end user. Read it before the end user starts a widget checkout.

## Headers

- `X-Locus-Session-Id` string

## Response `200`

Amount constraints

- TopupConstraintsEnvelope
  - `success` unknown, required
  - `constraints` TopupConstraints, required
    - `currency` 'USD', required
    - `minUsd` string, required
    - `maxUsd` 'null', nullable, required: No fixed platform maximum; commercial and processor controls remain risk-based.
    - `incrementUsd` '0.01', required
    - `maxAmountDecimalPlaces` unknown, required
    - `amountEncoding` 'decimal_string', required
    - `creditsPerDollar` string, required
    - `purchasingEnabled` boolean, required: False when this tenant cannot currently create checkout sessions or buy credits.
    - `disabledReason` 'funding_unavailable' | 'null', nullable, required
    - `bonusTiers` object[]: Volume-bonus cliff tiers over creditsUsd — the highest reached tier applies to the whole purchase. Management surface only; omitted from the end-user /me config because end-user top-ups never earn a bonus.
      - `minUsd` string, required
      - `bonusBps` integer, required

---

[API](https://skmtc.dev/paywithlocus/apis/locus-pro-api.md) - [All operations](https://skmtc.dev/paywithlocus/apis/locus-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paywithlocus/apis/locus-pro-api/revisions/aab8fa5d6cef?raw)