VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List paywalls
Create a paywall
Retrieve a paywall
Update a paywall
Delete a paywall
Archive a paywall
Unarchive a paywall
List a paywall's builds
Build a paywall
Retrieve a paywall build
Deploy a paywall build

Retrieve a paywall build

Reads one build of the paywall.

Guide: Paywalls in your app

Errors

StatustypecodeWhen
404not_foundpaywall_build_not_foundWhen the paywall has no such build.

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
  • 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
  • Deploy a paywall build POST

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousBuild a paywallNextDeploy a paywall build

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Paywalls
GET
/api/v1/projects/{projectId}/paywalls/{paywallId}/builds/{buildId}

Authorization

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_....

buildId*string

The build's id, pw_build_....

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls/pw_h7d2k9m4x1c6v8b3n5q0w2e7/builds/pw_build_k3v8n1q6x2c9m4h7d5b0w8e2" \  -H "Authorization: Bearer vh_sk_..."
{  "id": "pw_build_k3v8n1q6x2c9m4h7d5b0w8e2",  "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7",  "number": 3,  "status": "ready",  "documentVersion": 41,  "isDeployed": true,  "deployedAt": "2026-03-10T11:05:02.000Z",  "flowPackage": {    "abiVersion": 1,    "productIds": [      "pro_monthly",      "pro_annual"    ],    "sha256": "4f1c9a7e2b8d6035c1e9f4a2b7d0c8e3f6a19b5d2c7e0f8a3b6d9c1e4f7a2b5d",    "url": "https://api.voidhash.com/f/4f1c9a7e2b8d6035c1e9f4a2b7d0c8e3f6a19b5d2c7e0f8a3b6d9c1e4f7a2b5d.vhfp"  },  "failure": null,  "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1",  "createdAt": "2026-03-10T11:03:30.000Z",  "finishedAt": "2026-03-10T11:03:41.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_build_not_found",    "message": "This paywall has no build pw_build_k3v8n1q6x2c9m4h7d5b0w8e2.",    "param": "buildId"  }}

{  "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