POST
/
track
/
sale

Authorizations

Authorization
string
headerrequired

Default authentication mechanism

Body

application/json
externalId
string
default:

This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.

customerId
string | null
deprecated

This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.

amount
integer
required

The amount of the sale. Should be passed in cents.

paymentProcessor
enum<string>
required

The payment processor via which the sale was made.

Available options:
stripe,
shopify,
paddle
eventName
string
default: Purchase

The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc.

invoiceId
string | null

The invoice ID of the sale.

currency
string
default: usd

The currency of the sale. Accepts ISO 4217 currency codes.

metadata
object | null

Additional metadata to be stored with the sale event.

Response

200 - application/json
eventName
string
required
customer
object
required
sale
object
required

Was this page helpful?

Track a leadCreate a customer