Create a new session

POST

sessions

Authorizations

X-Api-Key

string

headerrequired

Body

application/json

projectId

string

required

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.

currency

enum<string>

required

The ISO 4217 currency code to be used throughout the negotiation. This will be used for all products.

Available options:

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

products

object[]

required

An array of products to be included in the negotiation.

products.id

string

required

Your unique ID of the product.

Maximum length: 1000

products.name

string

required

The name of the product.

Maximum length: 1000

products.description

string

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.

Maximum length: 1000

products.image

string

The public URL of the product image. Can be png, jpg, gif, svg or webp.

products.price

object

required

products.quantity

object

products.recurring

object

The payment interval, if the product is a subscription.

products.trial

object

The payment interval, if the product is a subscription.

products.metadata

object

Custom metadata to be included with the product.

products.upsellProduct

object

A higher-tier product intended to replace the original item, often offering enhanced features or value. This is commonly known as an up-sell.

products.upsellProduct.id

string

required

Your unique ID of the product.

Maximum length: 1000

products.upsellProduct.name

string

required

The name of the product.

Maximum length: 1000

products.upsellProduct.price

object

required

products.upsellProduct.description

string

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.

Maximum length: 1000

products.upsellProduct.image

string

The public URL of the product image. Can be png, jpg, gif, svg or webp.

products.upsellProduct.quantity

object

products.upsellProduct.recurring

object

The payment interval, if the product is a subscription.

products.upsellProduct.trial

object

The payment interval, if the product is a subscription.

products.upsellProduct.metadata

object

Custom metadata to be included with the product.

callbacks

object

A set of callback URLs for the session. If you are using SaleSnip inside the widget, these fields can be left empty.

crossSellProducts

object[]

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.

crossSellProducts.id

string

required

Your unique ID of the product.

Maximum length: 1000

crossSellProducts.name

string

required

The name of the product.

Maximum length: 1000

crossSellProducts.description

string

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.

Maximum length: 1000

crossSellProducts.image

string

The public URL of the product image. Can be png, jpg, gif, svg or webp.

crossSellProducts.price

object

required

crossSellProducts.quantity

object

crossSellProducts.recurring

object

The payment interval, if the product is a subscription.

crossSellProducts.trial

object

The payment interval, if the product is a subscription.

crossSellProducts.metadata

object

Custom metadata to be included with the product.

metadata

object

Custom metadata to be included with the session.

Response

201 - application/json

string

required

The unique ID of the session. You can use this to open SaleSnip as a widget.

url

string

required

The hosted URL of the session. You can redirect users to this URL to use SaleSnip in a standalone mode.

Update a single project Get a single session

Projects

Sessions

Plugins

Authorizations

Body

Response