List products

Lists the project's products, optionally only one type or the one with a slug.

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Products

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

PreviousRetrieve an erasure NextCreate a product

On this page

Authorization Path parameters Query parameters Examples Response body Errors More in Products

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.

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

type?string

Only products of this type: subscription, one_time or one_time_consumable.

Value in

"subscription"
"one_time"
"one_time_consumable"

slug?string

Only the product with this slug; the page then holds at most one.

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/products?type=subscription" \  -H "Authorization: Bearer vh_sk_..."

{  "data": [    {      "id": "prod_x8k2m5q9v3n7c1z4w6e0r2t5",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "Pro monthly",      "slug": "pro_monthly",      "type": "subscription",      "billingPeriod": "monthly"    },    {      "id": "prod_q4w8e2r6t1y5u9i3o7p0a2s6",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "name": "Pro annual",      "slug": "pro_annual",      "type": "subscription",      "billingPeriod": "annual"    }  ],  "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": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

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

List products

Errors

More in Products

List products

Errors

More in Products

Authorization

Path parameters

Query parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

List products

List products

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`