Products

Fetch product and their pricing

Received Products' APIs allow our users to manage their products and pricing models. The APIs support operations such as creating new products and pricing models, updating existing products, and fetching products to use in customer contracts and subscriptions.

Endpoint on this page

GET https://api.received.ai/api/products

Don't forget! APIs must include:

1. Bearer Token - return from the login call

2. API version - {"Version": "V0"}

Getting Products and Pricing

Fetching products and pricing provides detailed listings of available offerings and their associated costs. This information is crucial to build a contract, tailor their purchase orders, and negotiate contracts effectively.

Get Products

GET https://api.received.ai/api/products

Response

[
    {
      "pricing_ref": "35bfdd59-6462-4ec6-bd7b-b3e654d85774",
      "product_name": "Subscriptions",
      "pricing_name": "Plans",
      "line_items": [
        {
          "line_item_ref": "e72dd70c-cc65-4804-af2f-2fe6dab5f689"
          "item": "Starter",
          "price": 3000,
          "quantity": 1,
          "amount": 3000
        },
        {
          "line_item_ref": "e72dd70c-cc65-4804-af2f-2fe6dab5f680"
          "item": "Professional",
          "price": 6000,
          "quantity": 1,
          "amount": 6000
        },
        {
          "line_item_ref": "e72dd70c-cc65-4804-af2f-2fe6dab5f681"
          "item": "Organization",
          "price": 9000,
          "quantity": 1,
          "amount": 9000
        }
      ]
    },
    {
      "pricing_ref": "946ba17b-6f16-491e-bfa3-d189e827a9a3",
      "product_name": "Pay-as-you-go",
      "pricing_name": "Tiered",
      "line_items": [
        {
          "line_item_ref": "e72dd70c-cc65-4804-af2f-2fe6dab5f682"
          "item": "Starter",
          "price": 10,
          "quantity": 0,
          "amount": 0
        },
        {
          "line_item_ref": "e72dd70c-cc65-4804-af2f-2fe6dab5f683"
          "item": "Professional",
          "price": 9,
          "quantity": 0,
          "amount": 0
        },
        {
          "line_item_ref": "e72dd70c-cc65-4804-af2f-2fe6dab5f684"
          "item": "Organization",
          "price": 8,
          "quantity": 0,
          "amount": 0
        }
      ]
    }
]

Response Schema

Return list of pricing model with a product as a property. Those pricing and their lineitems can be used to build a contract (see Contract page)

Pricing Schema

Term	Type	Description	Example
pricing_ref	String	The ID of the related product pricing	35bfdd59-6462-4ec6-bd7b-b3e654d85774
product_name	String	The pricing's related product	Subscription
pricing_name	String	Name of the pricing	Plans
line_items	Array	List of pricing related lineitems

Lineitem Schema

Term	Type	Description	Example
line_item_ref	String	The ID of the related lineitem	e72dd70c-cc65-4804-af2f-2fe6dab5f689
item	String	Item name	Starter
price	String	Item price	30000
quantity	String	Item quantity	1
amount	Array	Total amount of the item	3000