Create a paywall location
Creates a location showing nothing.
Apps ask for it by its slug, which 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 location's name, shown in the dashboard.
1 <= lengthThe location's slug, unique in the project; apps ask for the location by it, and it cannot change afterwards.
1 <= lengthA note on where the location appears in the app.
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Settings upgrade", "slug": "settings-upgrade" }'{ "id": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Settings upgrade", "slug": "settings-upgrade", "description": null, "isArchived": false, "archivedAt": null, "showing": null, "createdAt": "2026-02-20T16:45:31.000Z", "updatedAt": "2026-02-20T16:45:31.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_location_slug_taken", "message": "Another paywall location in this project already uses the slug \"onboarding\".", "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_location_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 Paywall locations
Something wrong or missing on this page? Tell us by email or on Discord.