Create a paywall
Creates an empty paywall, or an onboarding flow with kind: onboarding.
The slug cannot change afterwards.
Guide: Paywalls in your app
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The paywall's name, shown in the dashboard.
1 <= lengthThe paywall's slug, unique in the project; it cannot change afterwards, and analytics refer to the paywall by it.
1 <= lengthWhat the flow is for: a paywall (the default) or an onboarding flow.
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Annual upsell", "slug": "annual-upsell" }'{ "id": "pw_h7d2k9m4x1c6v8b3n5q0w2e7", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Annual upsell", "slug": "annual-upsell", "kind": "paywall", "isArchived": false, "archivedAt": null, "thumbnailUrl": null, "createdAt": "2026-02-20T16:42:10.000Z", "updatedAt": "2026-02-20T16:42:10.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Missing key\n at [\"name\"]" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "conflict", "code": "paywall_slug_taken", "message": "Another paywall in this project already uses the slug \"annual-offer\".", "param": "slug" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 409 | conflict | paywall_slug_taken | When the slug is in use. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Paywalls
- List paywalls
GET - Retrieve a paywall
GET - Update a paywall
PATCH - Delete a paywall
DELETE - Archive a paywall
POST - Unarchive a paywall
POST - List a paywall's builds
GET - Build a paywall
POST - Retrieve a paywall build
GET - Deploy a paywall build
POST
Something wrong or missing on this page? Tell us by email or on Discord.