Skip to main content
POST
Quote a top-up (exact-decimal gross-up)

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Body

application/json

Quote pricing for a hypothetical top-up. Declare externalUserId when the eventual create targets an end user, so the quote's bonus fields match what the create will actually grant (end-user top-ups never earn a volume bonus).

usd
string
required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
credits
string

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
externalUserId
string

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$

Response

Quote

success
any
required
quote
object
required