Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
Product

List of products

Returns the list of products

get/api/v1/products

Query parameters

pagenumber

Page number. Starts from 1

limitnumber

Number of items per page

isnullboolean

Returns null values

notnullboolean

Returns not null values

gtstring date-time

Returns values greater than the given date

gtestring date-time

Returns values greater than or equal to the given date

ltstring date-time

Returns values less than the given date

ltestring date-time

Returns values less than or equal to the given date

Filter by created date

idsstring

Filter by id. Returns items with given ids

visibilitystring

To filter products by visibility

isActiveboolean

If true, only active products will be returned

urlstring

To filter products by url

priceTypesstring

To filter products by price type

interval'day' | 'week' | 'month' | 'year'

The interval at which to bill for this price. Only required for subscriptions

intervalCountnumber

It is used to determine the frequency at which the subscription is billed. Only required for subscriptions

priceCurrencystring

To filter products by price currency

Response

pagenumber required

Page number. Starts from 1

limitnumber required

Number of items per page

countnumber required
hasMoreboolean required

Example response

{
  "page": 1,
  "limit": 10,
  "count": 1,
  "query": {
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
      "defaultPrice": {
        "productId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
        "intervalCount": 1,
        "product": {
          "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
        }
      }
    }
  ]
}