---
title: Reference
description: Every tagged public module in the four packages, generated from the JSDoc beside its source.
sidebar:
  label: Overview
---

The reference documents every public export in `packages/*/src` that carries a
`@primitive`, `@resource`, `@binding` or `@layer` tag. One page is one source
module. The `Source` line at the top links to the file and line the text came
from.

The pages are generated. To change one, change the JSDoc in the package and run
`pnpm docs:reference`.

## Packages

**[Paykit](/reference/paykit)**

The model, the catalog, the bindings, the database layers, and the manual provider.

**[Paykit Polar](/reference/paykit-polar)**

Polar as a provider, and the products its tiers are sold as.

**[Paykit Stripe](/reference/paykit-stripe)**

Stripe as a provider, and the prices and meters its tiers are sold as.

**[Paykit Admin](/reference/paykit-admin)**

The Foldkit console over the admin read contract.

## What a page is

A metadata line names the kind of value a declaration exports.

- **Binding** is a `Binding.Service` for one command or operation. It binds an
  account or a deployment, and returns the verb a caller sends.
- **Layer** is an Effect `Layer` a deployment provides to close a service.
- **Resource** is an Alchemy resource the deploy creates and reconciles with a
  vendor.
- **Primitive** is a plain exported function, type or service the other three
  are built from.

Each package page also lists its public entry points, so an import path in the
reference can be checked against `package.json`.

## Package overview

[Packages](/reference/packages) says what each of the four packages owns and
which example deploys it.