Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Path Parameters

string
required
Product type for filtering, list all product with filter:
  • generic_link
  • physical_product
  • event
  • webinar
  • digital_product
  • coaching
  • course
  • cohort_based
  • fundraising
  • ebook
  • podcast
  • audiobook
  • membership
  • zakat
  • invoice
  • bundling
  • saas
  • payment_request
  • support

Query Parameters

Filter the listed products by name keyword.
integer
default:"10"
Number of items to return per page. Defaults to 10, with a maximum of 50.
string
Cursor for forward pagination. Pass the nextStartingAfter value from the previous response (a Unix timestamp in milliseconds, as a string) to fetch the next page.

Response

Successful Response

Main Structure (Root)

integer
Status code form API.
string
Status message that describes the status code.
array of object
List of products of the requested type.
boolean
Information on whether there is additional data to be retrieved (true/false).
string | null
Cursor to pass as startingAfter to fetch the next page. null when there is no further data.

data Structure (Array Of Object)

string
Unique identifier of the product.
integer
Product price amount.
string | null
Product category if available.
number
Timestamp in milliseconds indicating when the product was created.
string
Product description in HTML format.
Unique slug or identifier used in the product URL.
string
Product type (e.g., saas, event, membership, ebook, etc.).
string | null
Product subtype if applicable.
string
Current product status (e.g., active, inactive).
string
Product name.
integer | null
Purchase or access limit if configured.
string | null
URL where the customer will be redirected after checkout.
string | null
Installment identifier if the product supports installment payments.
string | null
Product variant.
array | null
Membership product tier.
object | null
Event details.
object | null
Order configuration if applicable.
string | null
Identifier of the cover image.
string | null
Identifier list of additional images.
object | null
Cover image object containing image details.
array | null
List of additional image objects.
array | null
Product variants.
Public product page URL.
Public payment link URL.