Get machine-readable top-up constraints

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

get/credits/me/topups/config

Request

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

Headers

X-Locus-Session-Idstring

Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.

Response

Amount constraints

successunknown required

Example response

{
  "constraints": {
    "minUsd": "5.00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.