Create a paywall

The slug cannot change afterwards.

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

Path parameters

projectId*string

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.

name*string

The paywall's name, shown in the dashboard.

Length1 <= length

slug*string

The paywall's slug, unique in the project; it cannot change afterwards, and analytics refer to the paywall by it.

Length1 <= length

kind?|

What 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."  }}

Errors

More in Paywalls

Create a paywall

Errors

More in Paywalls

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create a paywall

Create a paywall

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`