Retrieve a paywall
Reads one paywall, archived or not.
Guide: Paywalls in your app
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
projectId*string
The project's id, proj_.... A secret key works only in the project it belongs to.
paywallId*string
The paywall's id, pw_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls/pw_h7d2k9m4x1c6v8b3n5q0w2e7" \ -H "Authorization: Bearer vh_sk_..."{ "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-03-10T11:03:27.000Z"}{ "error": { "type": "invalid_request", "code": "string", "message": "string", "param": "string" }}{ "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": "paywall_not_found", "message": "This project has no paywall pw_h7d2k9m4x1c6v8b3n5q0w2e7.", "param": "paywallId" }}{ "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
Errors
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | paywall_not_found | — |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Paywalls
- List paywalls
GET - Create a paywall
POST - 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.