billing

Billing Checkout Status

Reconcile the Checkout Session the browser returned with.

200 {paid: bool, status, tier, period} when the Session is the caller's; 404 otherwise (or when it does not exist); 400 on a malformed id; 503 when Stripe cannot be asked. Never provisions anything -- the webhook owns the tier write; this only tells the client whether to stop celebrating.

get/api/billing/checkout-status

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/billing/checkout-status
  • Auth: none declared

Query parameters

session_idstring required

Response

Successful Response

paidboolean required

True iff the Session is 'complete' and its payment_status is 'paid' or 'no_payment_required'.

statusstring nullable

Stripe Session status: 'open' | 'complete' | 'expired'.

tierstring nullable

The tier the Session was created for (metadata.tier).

periodstring nullable

'monthly' | 'annual' (metadata.period).

Changes

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