Create a product

Discover how to create a product. You can create a product without coding (via Speed web application) or programmatically (via product APIs).

Create products via Speed web application

On the left sidebar, click on Products.
Click on the Add product button.
After clicking the Add product button, you are redirected to the Create page. Here you can fill out the required details, including name, and optional details like description and image.
Click on Next.
Fill in the price information for the product.
Click the Add another price button to add multiple prices for the product.
Click on Add Product. This will redirect you to the product detail page, where you can see the product details and all its prices.
Now, create an invoice using this product.

Create products via API

Create a product using the /products endpoint and basic details such as name, description, image, and others. In the example below, we’ll show how you can create a product.

Make a POST /products request specifying the following mandatory parameter.

name

{
  "name":"Product Name",
  "description":"description",
  "metadata":{
    "key":"value"
  },
  "images":[
    "https://23477318.fs1na1.net/23477/office-600x400.jpg"
  ]
}

You can also include other optional parameters, for example, description, images.

Request parameters

Provide the basic information outlined in the table below:

Parameter	Required	Type	Description
Name	✅	String	You can use this parameter to add a name of your product.
Description		String	You can use this parameter to provide a brief description of your product.
Images		String Array	You can use this parameter to add an image for the product. It should be a public URL for an image either in jpg, jpeg or png format.
Metadata		Object	You can use this object to store additional information in key-value pairs about the product object in a structured format. You can add up to 50 key-value pairs in a raw JSON format.

More information can be found in our API reference.

Response Attributes

Your response contains the following attributes:

{
    "id": "prod_lkqpcfafvmbvzwXE",
    "object": "product",
    "name": "Product Name",
    "description": "description",
    "images": [
        "https://23477318.fs1na1.net/23477/office-600x400.jpg"
    ],
    "metadata": {
        "key": "value"
    },
    "active": true,
    "created": 1690797783399,
    "modified": 1690797783399
}

Attributes

id (string)
Unique identifier for the object.

object (string)
The type of the object indicates to which entity this response belongs.

name (string)
This attribute represents the name of the product.

description (string)
This attribute represents additional information about your product.

images (array string)
Represents a public URL consisting of an image for the product.

metadata (object)
You can use this to store additional information about the object in a structured format.

active (boolean)
Active attribute can have 2 values as mentioned below:

true
Upon generation, by default, it will be true.
false

created (timestamp)
Time at which the product was created.

modified (timestamp)
Time at which the last modification was made.