Start a Stripe Checkout Session for a paid tier

Creates a subscription-mode Stripe Checkout Session for the named tier at its current Stripe price and returns the hosted url to send the buyer to. metadata.tier is set on the session from the price's own tier metadata, which is what the webhook reads to issue the key. Promotion codes are accepted on Stripe's page; pass promotion_code to pre-apply one. Not billable against the daily quota, but rate limited like every other /v1/ route (60 requests/minute per IP without a key). 503 when self-serve checkout is not configured on the deployment or the tier has no live price — email hello@hlaverify.com in that case.

post/v1/checkout

Request

  • Base URL: https://api.hlaverify.com
  • URL: https://api.hlaverify.com/v1/checkout
  • Auth: one of:
    • none
    • API key in header X-API-Key

Request body

tier'starter' | 'lab' | 'scale'

Which plan to buy.

pricestring

A specific active Stripe price id, instead of (or as a cross-check on) tier.

promotion_codestring

A customer-facing promotion code to pre-apply, for example a launch discount.

Response

checkout session created

urlstring required

Hosted Stripe Checkout url; send the buyer here.

session_idstring
tierstring required
pricestring
amountinteger

Unit amount in the currency's minor unit, as Stripe holds it.

currencystring
intervalstring
promotion_code_appliedboolean

Changes

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