Create a new session
curl --request POST \
--url https://api.salesnip.com/v1/sessions \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"projectId": "project_abcdefghjijklmnop",
"currency": "USD",
"callbacks": {
"success": "https://example.com/salesnip/success?sessionId={SESSION_ID}",
"cancel": "https://example.com/salesnip/cancel?sessionId={SESSION_ID}"
},
"products": [
{
"id": "your_product_id",
"name": "Product Name",
"description": "Product Description",
"image": "https://example.com/product.png",
"price": {
"initial": 100,
"minimum": 80
},
"quantity": {
"initial": 1,
"maximum": 10,
"minimum": 1
},
"recurring": {
"unit": "MONTH",
"count": 6
},
"trial": {
"unit": "MONTH",
"count": 6
},
"metadata": {
"description": "This is a description of the product"
},
"upsellProduct": {
"id": "your_product_id",
"name": "Product Name",
"description": "Product Description",
"image": "https://example.com/product.png",
"price": {
"initial": 100,
"minimum": 80
},
"quantity": {
"initial": 1,
"maximum": 10,
"minimum": 1
},
"recurring": {
"unit": "MONTH",
"count": 6
},
"trial": {
"unit": "MONTH",
"count": 6
},
"metadata": {
"description": "This is a description of the product"
}
}
}
],
"crossSellProducts": [
{
"id": "your_product_id",
"name": "Product Name",
"description": "Product Description",
"image": "https://example.com/product.png",
"price": {
"initial": 100,
"minimum": 80
},
"quantity": {
"initial": 1,
"maximum": 10,
"minimum": 1
},
"recurring": {
"unit": "MONTH",
"count": 6
},
"trial": {
"unit": "MONTH",
"count": 6
},
"metadata": {
"description": "This is a description of the product"
}
}
],
"metadata": {
"some_important_info": "SaleSnip is awesome!"
}
}'{
"id": "session_abcdefghjijklmnop",
"url": "https://chat.salesnip.com/#abcdefghjijklmnop"
}Authorizations
Body
The id of the SaleSnip project for this session. You can locate your project ID in the SaleSnip dashboard under the 'Keys' tab on the project level.
"project_abcdefghjijklmnop"
The ISO 4217 currency code to be used throughout the negotiation. This will be used for all products.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CKD, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, EHP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PND, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SLS, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWB, ZWL "USD"
An array of products to be included in the negotiation.
Your unique ID of the product.
1000"your_product_id"
The name of the product.
1000"Product Name"
A short description of the product that helps the AI to understand the product. Try to keep it short and concise, but include the most important information.
1000"Product Description"
The public URL of the product image. Can be png, jpg, gif, svg or webp.
"https://example.com/product.png"
The initial quantity of the product. Defaults to 1.
1 <= x <= 10000001
The maximum quantity of the product that can be added during the negotiation. Must be greater than or equal to the initial quantity.
1 <= x <= 100000010
The minimum quantity that can be set by the user during the negotiation. Must be less than or equal to the initial quantity.
1 <= x <= 10000001
The payment interval, if the product is a subscription.
The payment interval, if the product is a subscription.
SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR "MONTH"
Indicates the number of units in each billing interval. For example, a value of 2 with a unit of week means that the subscription will be billed every two weeks. This defaults to 1.
1 <= x <= 10000006
The payment interval, if the product is a subscription.
The unit of time for the trial period.
SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR "MONTH"
The number of interval units that make up the trial period. For example, a value of 2 with a unit of week means that the trial period will last for two weeks. This defaults to 1.
1 <= x <= 10000006
Custom metadata to be included with the product.
{
"description": "This is a description of the product"
}
A higher-tier product intended to replace the original item, often offering enhanced features or value. This is commonly known as an up-sell.
Your unique ID of the product.
1000"your_product_id"
The name of the product.
1000"Product Name"
A short description of the product that helps the AI to understand the product. Try to keep it short and concise, but include the most important information.
1000"Product Description"
The public URL of the product image. Can be png, jpg, gif, svg or webp.
"https://example.com/product.png"
The initial quantity of the product. Defaults to 1.
1 <= x <= 10000001
The maximum quantity of the product that can be added during the negotiation. Must be greater than or equal to the initial quantity.
1 <= x <= 100000010
The minimum quantity that can be set by the user during the negotiation. Must be less than or equal to the initial quantity.
1 <= x <= 10000001
The payment interval, if the product is a subscription.
The payment interval, if the product is a subscription.
SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR "MONTH"
Indicates the number of units in each billing interval. For example, a value of 2 with a unit of week means that the subscription will be billed every two weeks. This defaults to 1.
1 <= x <= 10000006
The payment interval, if the product is a subscription.
The unit of time for the trial period.
SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR "MONTH"
The number of interval units that make up the trial period. For example, a value of 2 with a unit of week means that the trial period will last for two weeks. This defaults to 1.
1 <= x <= 10000006
Custom metadata to be included with the product.
{
"description": "This is a description of the product"
}
A set of callback URLs for the session. If you are using SaleSnip inside the widget, these fields can be left empty.
The URL to redirect to after successfully completing the session. The {SESSION_ID} placeholder will be automatically replaced with the actual session ID upon redirection.
"https://example.com/salesnip/success?sessionId={SESSION_ID}"
The URL to redirect to if the session is cancelled before completion. The {SESSION_ID} placeholder will be automatically replaced with the actual session ID upon redirection. If this is left empty, the cancel button will be automatically hidden.
"https://example.com/salesnip/cancel?sessionId={SESSION_ID}"
A selection of complementary products that can be added to the original purchase to enhance or extend its value. This is commonly known as a cross-sell.
Your unique ID of the product.
1000"your_product_id"
The name of the product.
1000"Product Name"
A short description of the product that helps the AI to understand the product. Try to keep it short and concise, but include the most important information.
1000"Product Description"
The public URL of the product image. Can be png, jpg, gif, svg or webp.
"https://example.com/product.png"
The initial quantity of the product. Defaults to 1.
1 <= x <= 10000001
The maximum quantity of the product that can be added during the negotiation. Must be greater than or equal to the initial quantity.
1 <= x <= 100000010
The minimum quantity that can be set by the user during the negotiation. Must be less than or equal to the initial quantity.
1 <= x <= 10000001
The payment interval, if the product is a subscription.
The payment interval, if the product is a subscription.
SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR "MONTH"
Indicates the number of units in each billing interval. For example, a value of 2 with a unit of week means that the subscription will be billed every two weeks. This defaults to 1.
1 <= x <= 10000006
The payment interval, if the product is a subscription.
The unit of time for the trial period.
SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR "MONTH"
The number of interval units that make up the trial period. For example, a value of 2 with a unit of week means that the trial period will last for two weeks. This defaults to 1.
1 <= x <= 10000006
Custom metadata to be included with the product.
{
"description": "This is a description of the product"
}
Custom metadata to be included with the session.
{
"some_important_info": "SaleSnip is awesome!"
}
Response
The unique ID of the session. You can use this to open SaleSnip as a widget.
"session_abcdefghjijklmnop"
The hosted URL of the session. You can redirect users to this URL to use SaleSnip in a standalone mode.
"https://chat.salesnip.com/#abcdefghjijklmnop"
curl --request POST \
--url https://api.salesnip.com/v1/sessions \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"projectId": "project_abcdefghjijklmnop",
"currency": "USD",
"callbacks": {
"success": "https://example.com/salesnip/success?sessionId={SESSION_ID}",
"cancel": "https://example.com/salesnip/cancel?sessionId={SESSION_ID}"
},
"products": [
{
"id": "your_product_id",
"name": "Product Name",
"description": "Product Description",
"image": "https://example.com/product.png",
"price": {
"initial": 100,
"minimum": 80
},
"quantity": {
"initial": 1,
"maximum": 10,
"minimum": 1
},
"recurring": {
"unit": "MONTH",
"count": 6
},
"trial": {
"unit": "MONTH",
"count": 6
},
"metadata": {
"description": "This is a description of the product"
},
"upsellProduct": {
"id": "your_product_id",
"name": "Product Name",
"description": "Product Description",
"image": "https://example.com/product.png",
"price": {
"initial": 100,
"minimum": 80
},
"quantity": {
"initial": 1,
"maximum": 10,
"minimum": 1
},
"recurring": {
"unit": "MONTH",
"count": 6
},
"trial": {
"unit": "MONTH",
"count": 6
},
"metadata": {
"description": "This is a description of the product"
}
}
}
],
"crossSellProducts": [
{
"id": "your_product_id",
"name": "Product Name",
"description": "Product Description",
"image": "https://example.com/product.png",
"price": {
"initial": 100,
"minimum": 80
},
"quantity": {
"initial": 1,
"maximum": 10,
"minimum": 1
},
"recurring": {
"unit": "MONTH",
"count": 6
},
"trial": {
"unit": "MONTH",
"count": 6
},
"metadata": {
"description": "This is a description of the product"
}
}
],
"metadata": {
"some_important_info": "SaleSnip is awesome!"
}
}'{
"id": "session_abcdefghjijklmnop",
"url": "https://chat.salesnip.com/#abcdefghjijklmnop"
}