Products
Get products
- Documentation
- API Reference
- Integrations
- Changelog
- Blog
- GETGet analytics
- GETGet companies
- GETGet custom properties
- POSTCreate custom property
- PUTUpdate custom property
- DELDelete custom property
- GETGet customers
- POSTCreate customer
- GETGet customer
- PUTUpdate customer
- DELDelete customer
- GETGet customer portal
- PUTArchive customer
- POSTBulk update providers/customers mapping
- GETList credit products
- POSTCreate credit product
- GETGet credit product
- GETList credit transactions
- POSTPurchase credits
- POSTTopup credits
- POSTCreate credits usage
- POSTCreate component token
- GETGet invoices
- POSTCreate one-off invoice
- POSTSends a draft invoice for payment
- GETGet invoice
- GETDownload invoice
- POSTCreate transaction
- GETGet invoicing entities
- POSTCreate invoicing entity
- GETGet invoicing entity
- PUTUpdate invoicing entity
- DELDelete invoicing entity
- POSTCreate payment
- POSTUpdate prices
- GETGet quotes
- POSTCreate quote
- GETGet quote
- GETDownload quote
- POSTSend quote
- POSTVoid quote
- GETDownload quote file
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCancel subscription
- POSTReinstate subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- PUTUpdate subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Quotes
Subscriptions
Products
Get products
Retrieve all existing products.
GET
/
v1
/
products
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
take
number
take
number
skip
number
skip
number
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
take
number | null
default: 50skip
number | null
default: 0Response
200 - application/json
meta
object
requiredmeta.total
number
requiredTotal of existing items.
meta.taken
number
requiredNumber of items returned.
meta.skipped
number
requiredNumber of items skipped.
data
object[]
requiredList of Product.
data.id
string
requiredProduct ID.
data.name
string
requiredProduct name.
data.description
string | null
requiredProduct description.
data.public_description
string | null
requiredPublic description of the product.
data.type
enum<string>
requiredAvailable options:
flat_fee data.properties
object | null
requiredKey/value pairs to store any information you find useful.
data.translations
object | null
requiredProduct name and description translations.
data.custom_properties
object | null
requiredA list of key value with the ID or the name of the custom property as the key and the custom property value as value.
data.is_available_on_subscription
boolean
requiredEnable the product to be added as part of a subscription.
data.is_available_on_demand
boolean
requiredEnable the product to be billed at any time as a one-time payment.