envless.products.create()

def create(
    body: ProductCreate,
    *,
    timeout: float | None = None,
) -> ProductResource

async def create(
    body: ProductCreate,
    *,
    timeout: float | None = None,
) -> ProductResource

Creates a product in the workspace the key is bound to. Only name is required: an omitted slug is derived from the name, and a supplied slug is slugified before validation, so My Product and my-product both land on my-product.

The response is built from the freshly inserted row, not from a read back. isPrivate is always False, updatedAt is always None and there is no locked field even when the new product went in beyond the plan cap. Call get when you need the settled shape, and update when you need the product to be private.

Example#

from envless import envless

product = envless.products.create({'name': 'Billing'})

print(product['id'], product['slug'])

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        product = await envless.products.create({'name': 'Billing'})

        print(product['id'], product['slug'])


asyncio.run(main())

Parameters#

Returns#

ProductResource for the new product, with isPrivate False and no locked field.

Worth knowing#

Required scopes#

products:write

Underlying endpoint#

In TypeScript#