Retrieve a paywall location
Reads one location, archived or not, with what it shows now.
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.
paywallLocationId*string
The location's id, pw_loc_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9" \ -H "Authorization: Bearer vh_sk_..."{ "id": "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Onboarding upsell", "slug": "onboarding-end", "description": "After the last onboarding screen.", "isArchived": false, "archivedAt": null, "showing": { "id": "pw_loc_show_q2w8e4r6t1y9u3i7o5p0a2s4", "paywallLocationId": "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9", "type": "feature_flag", "paywallId": null, "buildNumber": null, "featureFlagId": "ff_k9m4x1c6v8b3n5q0w2e7h7d2", "startedAt": "2026-03-02T09:00:00.000Z", "endedAt": null, "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1" }, "createdAt": "2026-02-20T16:42:10.000Z", "updatedAt": "2026-03-02T09:00:00.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_location_not_found", "message": "This project has no paywall location pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9.", "param": "paywallLocationId" }}{ "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_location_not_found | — |
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.