Products

This resource represents a product, which can then later be used as a line item for an invoice, subscription, or payment link. Each product must have a unique name.

Properties

id string Unique id of the record createdAt string The date this item was created in RFC3339 format. updatedAt string The date this item was updated in RFC3339 format. object string The object type of this resource. name string Name of the product imageUrls array(string) A list of images for the product. description: string A rich description of the product, in either plaintext or HTML. status string Current status of the product. Options are active, archived

Example Product Object

{
    "id": "6851543f-399b-43ee-b3d0-ef681ec3fd6d",
    "createdAt": "2024-04-12T17:26:52.759700459Z",
    "name": "Website design",
    "imageUrls": [
        "https://lightout-portal.s3-accelerate.amazonaws.com/public/Tr8pJhPzp/images/products/81dd95e1-f950-4ff7-851d-686ceb70ec2b/TestProductImage.webp"
    ],
    "object": "product",
    "description": "<div><h1>Professional design</h1><p>Our design services are provided by experienced individuals with industry experience.</p></div>",
    "status": "active",
    "updatedAt": "2024-04-12T17:26:52.759700459Z"
}

Getting started

Webhooks

Core Resources

CRM

Messaging

Billing

Files

Contracts

Forms

Tasks

Token

Others

Properties

​Properties

Properties