Conversions [BETA]
Track a sale
Track a sale for a short link.
POST
/
track
/
sale
Authorizations
Authorization
string
headerrequiredDefault authentication mechanism
Body
application/json
amount
integer
requiredThe amount of the sale. Should be passed in cents.
Required range:
x > 0
paymentProcessor
enum<string>
requiredThe payment processor via which the sale was made.
Available options:
stripe
, shopify
, paddle
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.
Maximum length:
100
customerId
string | null
deprecatedThis is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
Maximum length:
100
eventName
string
default: PurchaseThe name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc.
Maximum length:
50
invoiceId
string | null
The invoice ID of the sale.
currency
string
default: usdThe 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
requiredcustomer
object
requiredsale
object
requiredWas this page helpful?