Create Product - Solifyn

POST

products

TypeScript SDK

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// Create a new product
const product = await solifyn.products.create({
  name: 'Premium SaaS Plan',
  price: 49.99,
  currency: 'usd',
  taxCategory: 'saas',
  pricingType: 'renewal',
  billingPeriod: 30
});
console.log('Product Created:', product);

{
  "id": "prod_9z8x7c6v5b4n",
  "name": "Enterprise SaaS Plan",
  "price": 99,
  "currency": "USD",
  "status": "ACTIVE",
  "imageUrl": "https://assets.solifyn.com/images/products/saas-enterprise.png",
  "taxCategory": "saas",
  "pricingType": "one_time",
  "discount": 0,
  "hasLicenseKey": true,
  "hasDigitalDelivery": false,
  "isTaxInclusive": false,
  "billingPeriod": null,
  "trialPeriodDays": null,
  "expirationDays": null,
  "statementDescriptor": "SOLIFYN*SAAS",
  "payWhatYouWant": false,
  "metadata": {
    "tier": "enterprise",
    "department": "engineering"
  },
  "customFields": [
    {
      "id": "57aa2241-eae4-43dc-b9ae-36069b84b2da",
      "name": "Discord Username",
      "order": 0,
      "required": true,
      "field_type": "text",
      "placeholder": "e.g. your_discord#1234"
    },
    {
      "id": "c86da32a-a967-457c-815b-c3440294d70b",
      "name": "Company Name",
      "order": 1,
      "required": false,
      "field_type": "text",
      "placeholder": "e.g. Acme Corp (Optional)"
    }
  ],
  "stock": null,
  "activationLimit": 5,
  "isListed": true,
  "isFree": false,
  "createdAt": "2026-05-18T12:00:00.000Z",
  "updatedAt": "2026-05-18T12:00:00.000Z",
  "isPermanentlyDeleted": false,
  "brandId": "brd_4e29285b8sdf34ff51e07d4",
  "digitalLink": null,
  "instructions": "Log in to your Solifyn developer dashboard and enter your license key to activate the premium SaaS resources.",
  "activationMessage": "Activation successful. Welcome to the Solifyn Enterprise Plan!",
  "expiryHours": 8760,
  "businessId": "biz_4r5t6y7u8i9o",
  "description": "Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers."
}

Authorizations

Authorization

string

header

required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Body

application/json

name

string

required

Product display name.

Example:

"Enterprise SaaS Plan"

price

number

required

Price value.

Example:

99

currency

enum<string>

default:USD

required

Product pricing currency.

Available options:

USD,

SGD,

INR,

AUD,

BRL,

CAD,

DKK,

EUR,

NOK,

GBP,

SEK,

CHF,

HKD,

HUF,

JPY,

MXN,

MYR,

PLN,

CZK,

NZD,

AED,

COP,

RON,

THB,

BGN,

IDR,

DOP,

PHP,

TRY,

KRW,

TWD,

VND,

PKR,

CLP,

UYU,

ARS,

ZAR,

DZD,

TND,

MAD,

KES,

KWD,

JOD,

ALL,

XCD,

AMD,

BSD,

BHD,

BOB,

BAM,

KHR,

CRC,

XOF,

EGP,

ETB,

GMD,

GHS,

GTQ,

GYD,

ILS,

JMD,

MOP,

MGA,

MUR,

MDL,

MNT,

NAD,

NGN,

MKD,

OMR,

PYG,

PEN,

QAR,

RWF,

SAR,

RSD,

LKR,

TZS,

TTD,

UZS,

RUB,

CNY

Example:

"USD"

taxCategory

enum<string>

required

Tax classification.

Available options:

digital_products,

saas,

physical_products,

service

Example:

"saas"

description

string

A description of the product.

Example:

"Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers."

imageUrl

string

URL of the product cover image.

Example:

"https://assets.solifyn.com/images/products/saas-enterprise.png"

discount

number

Percentage or flat rate discount.

Example:

0

hasLicenseKey

boolean

default:false

Whether to automatically issue license keys upon successful orders.

Example:

false

hasDigitalDelivery

boolean

default:false

Whether the purchase includes downloadable files.

Example:

false

isTaxInclusive

boolean

default:false

Whether tax is included in the base price.

Example:

false

activationLimit

integer | null

Maximum concurrent activated instances allowed per license key.

Example:

null

brandId

string | null

Brand id for the product, if not provided will default to primary brand.

Example:

"brd_4e29285b8sdf34ff51e07d4"

billingPeriod

integer

Billing period in days (for Subscription products).

Example:

30

trialPeriodDays

integer

Trial duration in days.

Example:

7

expirationDays

integer

Subscription expiration duration in days.

statementDescriptor

string

Custom billing descriptor.

Example:

"SOLIFYN*SAAS"

payWhatYouWant

boolean

default:false

Allow pay-what-you-want pricing.

Example:

false

metadata

object

Developer key-value metadata pairs.

Show child attributes

Example:

{
  "internal_id": "12345",
  "campaign": "summer_sale"
}

customFields

object[]

Form field configurations to gather during checkout.

Show child attributes

Example:

[
  {
    "id": "57aa2241-eae4-43dc-b9ae-36069b84b2da",
    "name": "Discord Username",
    "order": 0,
    "required": true,
    "field_type": "text",
    "placeholder": "e.g. your_discord#1234"
  },
  {
    "id": "c86da32a-a967-457c-815b-c3440294d70b",
    "name": "Company Name",
    "order": 1,
    "required": false,
    "field_type": "text",
    "placeholder": "e.g. Acme Corp (Optional)"
  }
]

stock

integer

Initial stock quantity limit.

Example:

100

isListed

boolean

default:true

Whether the product is publicly visible.

Example:

true

isFree

boolean

default:false

Whether the product is free of charge.

Example:

false

addons

object[]

Product addons configurations.

Show child attributes

Response

201 - application/json

Product created successfully.

Represents a product item created under your business, containing core pricing, status, license behavior, subscription settings, and metadata details.

string<uuid>

required

The unique identifier (ID) of the product.

Example:

"prod_9z8x7c6v5b4n"

name

string

required

The display name of the product.

Example:

"Enterprise SaaS Plan"

price

number

required

The price amount of the product (e.g. 29.00).

Example:

99

currency

string

required

The three-letter ISO currency code (e.g. USD, VND, EUR).

Example:

"USD"

status

string

required

The lifecycle status of the product (e.g. ACTIVE, ARCHIVED).

Example:

"ACTIVE"

imageUrl

string | null

required

URL of the product cover image.

Example:

"https://assets.solifyn.com/images/products/saas-enterprise.png"

taxCategory

enum<string>

required

The tax classification for the product.

Available options:

digital_products,

saas,

physical_products,

service

Example:

"saas"

pricingType

enum<string>

required

Pricing model of the product.

Available options:

usage_based,

one_time,

renewal

Example:

"one_time"

discount

number | null

required

Discount value as a percentage or fixed amount.

Example:

0

hasLicenseKey

boolean

required

Indicates if the product issues a cryptographically secure software license key upon checkout completion.

Example:

true

hasDigitalDelivery

boolean

required

Whether the product includes digital file downloads upon purchase.

Example:

false

isTaxInclusive

boolean

required

Whether the product price already includes applicable sales taxes.

Example:

false

billingPeriod

integer | null

required

The subscription billing cycle interval in days (for subscription products).

Example:

null

trialPeriodDays

integer | null

required

Trial duration in days for subscription products.

Example:

null

expirationDays

integer | null

required

Automatic expiration period in days for the subscription entitlement.

Example:

null

statementDescriptor

string | null

required

Custom text displayed on customer credit card statements for purchases of this product.

Example:

"SOLIFYN*SAAS"

payWhatYouWant

boolean

required

Indicates if customers are allowed to enter a custom pricing amount at checkout.

Example:

false

metadata

object

required

Custom developer metadata key-value pairs associated with the product.

Show child attributes

Example:

{
  "tier": "enterprise",
  "department": "engineering"
}

customFields

object[] | null

required

Custom form field questions to ask the customer during checkout.

Example:

[
  {
    "id": "57aa2241-eae4-43dc-b9ae-36069b84b2da",
    "name": "Discord Username",
    "order": 0,
    "required": true,
    "field_type": "text",
    "placeholder": "e.g. your_discord#1234"
  },
  {
    "id": "c86da32a-a967-457c-815b-c3440294d70b",
    "name": "Company Name",
    "order": 1,
    "required": false,
    "field_type": "text",
    "placeholder": "e.g. Acme Corp (Optional)"
  }
]

stock

integer | null

required

Available stock quantity, or null for unlimited inventory.

Example:

null

activationLimit

integer

required

Maximum number of simultaneous active instances/devices allowed per issued license key (applicable if hasLicenseKey is true).

Example:

5

isListed

boolean

required

Defines if the product is listed publicly on the merchant's storefront template.

Example:

true

isFree

boolean

required

Whether the product is free.

Example:

false

createdAt

string<date-time>

required

Timestamp indicating exactly when the product was created.

Example:

"2026-05-18T12:00:00.000Z"

updatedAt

string<date-time>

required

Timestamp indicating when the product was last modified.

Example:

"2026-05-18T12:00:00.000Z"

isPermanentlyDeleted

boolean

required

Indicates if the product has been permanently deleted.

Example:

false

brandId

string | null

required

Optional brand identifier.

Example:

"brd_4e29285b8sdf34ff51e07d4"

digitalLink

string | null

required

Secure link for digital delivery.

Example:

null

instructions

string | null

required

Special instructions provided upon purchase.

Example:

"Log in to your Solifyn developer dashboard and enter your license key to activate the premium SaaS resources."

activationMessage

string | null

required

Custom message displayed when a license key is activated.

Example:

"Activation successful. Welcome to the Solifyn Enterprise Plan!"

expiryHours

integer | null

required

Number of hours until the license key expires.

Example:

8760

businessId

string

required

The unique identifier of the business owning this product.

Example:

"biz_4r5t6y7u8i9o"

description

string | null

A comprehensive rich text description of the product.

Example:

"Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers."

Update ProductUpdate details of an existing product.

⌘I

TypeScript SDK

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// Create a new product
const product = await solifyn.products.create({
  name: 'Premium SaaS Plan',
  price: 49.99,
  currency: 'usd',
  taxCategory: 'saas',
  pricingType: 'renewal',
  billingPeriod: 30
});
console.log('Product Created:', product);

{
  "id": "prod_9z8x7c6v5b4n",
  "name": "Enterprise SaaS Plan",
  "price": 99,
  "currency": "USD",
  "status": "ACTIVE",
  "imageUrl": "https://assets.solifyn.com/images/products/saas-enterprise.png",
  "taxCategory": "saas",
  "pricingType": "one_time",
  "discount": 0,
  "hasLicenseKey": true,
  "hasDigitalDelivery": false,
  "isTaxInclusive": false,
  "billingPeriod": null,
  "trialPeriodDays": null,
  "expirationDays": null,
  "statementDescriptor": "SOLIFYN*SAAS",
  "payWhatYouWant": false,
  "metadata": {
    "tier": "enterprise",
    "department": "engineering"
  },
  "customFields": [
    {
      "id": "57aa2241-eae4-43dc-b9ae-36069b84b2da",
      "name": "Discord Username",
      "order": 0,
      "required": true,
      "field_type": "text",
      "placeholder": "e.g. your_discord#1234"
    },
    {
      "id": "c86da32a-a967-457c-815b-c3440294d70b",
      "name": "Company Name",
      "order": 1,
      "required": false,
      "field_type": "text",
      "placeholder": "e.g. Acme Corp (Optional)"
    }
  ],
  "stock": null,
  "activationLimit": 5,
  "isListed": true,
  "isFree": false,
  "createdAt": "2026-05-18T12:00:00.000Z",
  "updatedAt": "2026-05-18T12:00:00.000Z",
  "isPermanentlyDeleted": false,
  "brandId": "brd_4e29285b8sdf34ff51e07d4",
  "digitalLink": null,
  "instructions": "Log in to your Solifyn developer dashboard and enter your license key to activate the premium SaaS resources.",
  "activationMessage": "Activation successful. Welcome to the Solifyn Enterprise Plan!",
  "expiryHours": 8760,
  "businessId": "biz_4r5t6y7u8i9o",
  "description": "Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers."
}