> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Payhip plugin

> Payhip is a digital products storefront. This plugin creates and manages discount coupons with the account API key, and verifies, enables, disables and counts software license keys with the per-product secret key. Coupon bodies are form-encoded as the API requires.

Use **Payhip** through Corsair: one client, typed API calls.

Two credentials are involved, both stored on the account. Coupon operations authenticate with the account API key (Developer Settings in the Payhip account) in the payhip-api-key header. License-key operations authenticate with a per-product secret key in the product-secret-key header; store that secret on the account (product\_secret\_key). You can find a product's secret key in the Payhip product settings, once license keys are on for that product. One connection holds one product secret, so license calls work on that product's keys. An unknown key answers 400.
Bodies are form-encoded, as the API requires; the plugin builds them for you. Payhip's purchase-event webhooks exist but their signature scheme is not documented in the API reference, so this plugin does not receive them.
Note on license.decreaseUsage: the reference's endpoint list names /api/v2/license/decrease while its curl example reuses the /usage URL; this plugin follows the endpoint list (checked live: /decrease exists).
Coupon dates: Payhip takes RFC 3339 with a numeric offset only; the plugin rewrites a Z suffix to +00:00 and drops fractional seconds.
Every operation is described in the official reference: [https://payhip.com/api-reference](https://payhip.com/api-reference)

**What you get:**

* 8 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/payhip better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/payhip better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/payhip better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/payhip better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { payhip } from '@corsair-dev/payhip';

export const corsair = createCorsair({
	plugins: [
		payhip(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Payhip API key before the first call: `pnpm corsair setup --plugin=payhip --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> payhip()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'payhip',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Verify a license key**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.payhip.api.license.verify({ license_key: 'WTKP4-66NL5-HMKQW-GFSCZ' });
```

**Create a coupon for one product**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.payhip.api.coupons.create({
	code: 'example123',
	coupon_type: 'single',
	product_key: 'PtRJw',
	percent_off: 25,
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/payhip/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/payhip/api.md)
>
> Every `payhip.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.