POST
/
v1
/
sessions
/
creem
curl --request POST \
  --url https://api.salesnip.com/v1/sessions/creem \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "enviroment": "test",
  "projectId": "project_abcdefghjijklmnop",
  "productId": "product_abcdefghjijklmnop",
  "minimumPrice": 10,
  "callbacks": {
    "success": "https://example.com/salesnip/success?sessionId={SESSION_ID}",
    "cancel": "https://example.com/salesnip/cancel?sessionId={SESSION_ID}"
  },
  "customer": {
    "id": "customer_abcdefghjijklmnop",
    "email": "[email protected]"
  },
  "discount": {
    "duration": {
      "mode": "once",
      "months": 1
    }
  },
  "customFields": [
    {
      "type": "text",
      "key": "custom_field_key",
      "label": "Custom Field Label",
      "optional": false,
      "validation": {
        "minLength": 5,
        "maxLength": 50
      }
    }
  ],
  "metadata": {
    "some_important_info": "SaleSnip is awesome!"
  }
}'
{
  "id": "session_abcdefghjijklmnop",
  "url": "https://chat.salesnip.com/#abcdefghjijklmnop"
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
enviroment
enum<string>
required

The enviroment of the Creem checkout session.

Available options:
test,
live
Example:

"test"

​
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.

Example:

"project_abcdefghjijklmnop"

​
productId
string
required

The Creem id of the product to be included in the session.

Example:

"product_abcdefghjijklmnop"

​
minimumPrice
number
required

The minimum price of the product that can be negotiated.

Example:

10

​
callbacks
object

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

​
customer
object

The customer details for the session. You may only specify one of id or email.

​
discount
object

Configuration for the Creem discount.

​
customFields
object[]

Collect additional information from your customers during the checkout. Allows up to 3 custom fields.

​
metadata
object

Custom metadata to be included with the session.

Example:
{
  "some_important_info": "SaleSnip is awesome!"
}

Response

201
application/json
Created
​
id
string
required

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

Example:

"session_abcdefghjijklmnop"

​
url
string
required

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

Example:

"https://chat.salesnip.com/#abcdefghjijklmnop"