Readiness

Prerequisites

Have these pieces ready before you start integrating the runtime API.

Start free in test mode. Go live when you're ready.

Category: Getting Started2 sections

What you need

  • A Stripe account with products and price IDs already created.
  • A backend that can keep Licenzy API keys private.
  • A stable subject_ref for each customer or user.
  • A Licenzy product catalog that maps product codes to Stripe price IDs.
  • Access to configure Stripe credentials in both test and live modes when needed.

First validation path

Before expanding the integration, prove one complete test-mode purchase path:

  1. Create one test product in the Licenzy portal.
  2. Call POST /v1/checkout/session with a fixed subject_ref.
  3. Complete the checkout in Stripe test mode.
  4. Wait for Stripe to deliver the webhook to Licenzy.
  5. Verify access with POST /v1/access/check.
  6. If applicable, consume usage with POST /v1/usage/consume.
Use one subject ID everywhere
Checkout, customer access reads, entitlement reads and usage consumption must all use the same subject_ref. That identifier is the key join across the runtime API.