Top-ups

Get authoritative checkout state

Returns the authoritative state of a workspace top-up checkout session. Poll it after Stripe Checkout instead of trusting the browser redirect.

get/credits/topups/{sessionId}

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/topups/{sessionId}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

sessionIdstring required

Response

Checkout state

successunknown required
sessionIdstring required
state'pending' | 'completed' | 'expired' required
paymentStatusstring required
fulfillment'awaiting_payment' | 'processing' | 'ready' | 'expired' | 'failed'

Ledger state. completed means Stripe was paid; credits are spendable once this is ready.

Changes

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