Skip to main content
POST
/
products
{
  "name": "Platform Fee",
  "sku":"PLATFORM_FEE",
  "description": "Monthly cost for accounting reconciliation software",
  "feeType": "fixed",
  "paymentTerms": "arrears",
  "billingFrequency": "recurring"
}


{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "sku": "<string>",
  "feeType": "<string>",
  "paymentTerms": "<string>",
  "billingFrequency": "<string>",
  "metricIds": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
{
  "name": "Platform Fee",
  "sku":"PLATFORM_FEE",
  "description": "Monthly cost for accounting reconciliation software",
  "feeType": "fixed",
  "paymentTerms": "arrears",
  "billingFrequency": "recurring"
}
​
id
string
The unique identifier for the product.
​
name
string
The name of the product.
​
description
string
A brief description of the product.
​
sku
string
A product code used in external ERP solutions of revenue recognition.
​
feeType
string
The fee type of the product, indicating whether the cost is fixed or based on usage (metered).
​
paymentTerms
string
The default billing direction for the product: advance (charged at the start of the billing period) or arrears (charged at the end). When creating prices on a subscription, this corresponds to the billingDirection field on each price, which can override the product default.
​
billingFrequency
string
The frequency at which the product is billed, e.g., recurring.
​
metricIds
[]string
The identifiers for the associated metrics. This field is applicable for metered products.
​
createdAt
date
The timestamp when the product was created.
​
updatedAt
date
The timestamp when the product was last updated.