Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Products

Retrieve a paginated list of products

Retrieves the paginated list of products, optionally filtered by customer key, stack key, or click xid.

get/v2/products

Query parameters

customer_keystring

The customer to fetch products for

stack_keystring

The stack key of the partner member

click_xidstring

The unique id for this transaction's click

order_by'-created_at' | 'created_at' | '-updated_at' | 'updated_at'

The field in which the results are ordered by

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Retrieves the paginated list of products, optionally filtered by customer key, stack key, or click xid.

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "amount": 1000,
        "click_xid": "click_1234567890",
        "company_id": 123,
        "currency": "USD",
        "customer_key": "cust_1234567890",
        "external_subscription_key": "sub_1234567890",
        "field_data": {
          "key": "value"
        },
        "member_email": "member@example.com",
        "member_logo": "https://cdn.example.com/profile_123.jpg",
        "member_name": "Jane Doe",
        "metadata": {
          "key": "value"
        },
        "name": "Premium Plan",
        "partner_logo": "https://cdn.example.com/logo.png",
        "partner_name": "Acme Agency",
        "partnership_key": "part_1234567890",
        "product_book_key": "prod_book_1234567890",
        "stack_key": "stack_1234567890",
        "status": "active",
        "team_color": "violet"
      }
    ]
  }
}