Create a product

A subscription needs a billingPeriod; a one-time product has none.

Errors

Status	`type`	`code`	When
409	`conflict`	`product_slug_taken`	When the slug is in use.

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

More in Products

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

name*string

The product's name.

slug*string

How SDKs and paywalls name the product, unique in the project, such as pro_monthly.

type*ProductType

What buying the product gives: subscription renews every billing period, one_time is kept for good, and one_time_consumable is used up, such as a pack of credits.

Value in

"subscription"
"one_time"
"one_time_consumable"

billingPeriod?|

How often the subscription renews. Required for a subscription; not allowed for one-time products.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/products" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Pro monthly",    "slug": "pro_monthly",    "type": "subscription",    "billingPeriod": "monthly"  }'

{  "id": "prod_x8k2m5q9v3n7c1z4w6e0r2t5",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Pro monthly",  "slug": "pro_monthly",  "type": "subscription",  "billingPeriod": "monthly"}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"name\"]"  }}

{  "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": "conflict",    "code": "product_slug_taken",    "message": "Another product in this project already uses the slug \"pro-monthly\".",    "param": "slug"  }}

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

Errors

More in Products

Create a product

Errors

More in Products

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create a product

Create a product

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`