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 persons
Create a person
Retrieve a person
Update a person
List a person's entitlements
List a person's purchases
List a person's subscriptions
Erase a person
Retrieve an erasure

List a person's subscriptions

Lists the person's subscriptions, most recently started first, including those of persons merged into them.

A secret key includes its own environment; a person's own credentials choose with x-environment: production (the default), test or all.

Guide: People and identity

GET
/api/v1/projects/{projectId}/persons/{personId}/subscriptions

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.

personId*string

The person's id, person_.... The id of a person merged into another names the person they were merged into.

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/persons/person_h7d2k9m4x1c6v8b3n5q0w2e7/subscriptions" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "sub_p9o3i7u1y5t8r2e6w0q4a8s2",      "productName": "Pro monthly",      "environment": "production",      "status": "active",      "startsAt": "2026-03-14T09:26:53.000Z",      "expiresAt": "2026-04-14T09:26:53.000Z",      "gracePeriodExpiresAt": null,      "isCancelingAtPeriodEnd": false,      "paymentSource": null    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}
{  "error": {    "type": "invalid_request",    "code": "invalid_query",    "message": "The request query is invalid: Expected a finite number\n  at [\"limit\"]"  }}
{  "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": "person_not_found",    "message": "This project has no person person_h7d2k9m4x1c6v8b3n5q0w2e7.",    "param": "personId"  }}

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

StatustypecodeWhen
404not_foundperson_not_foundFor an unknown or erased person.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Persons

  • List persons GET
  • Create a person POST
  • Retrieve a person GET
  • Update a person PATCH
  • List a person's entitlements GET
  • List a person's purchases GET
  • Erase a person POST
  • Retrieve an erasure GET

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

PreviousList a person's purchasesNextErase a person

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Persons