Track a sale

Track a sale for a short link.

Authorizations

Authorization

string

headerrequired

Default authentication mechanism

Body

application/json

amount

integer

required

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

Required range: x > 0

paymentProcessor

enum<string>

required

The 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

deprecated

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

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.

Maximum length: 50

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.

Show child attributes

metadata.{key}

any

Response

200 - application/json

eventName

string

required

customer

object

required

Show child attributes

customer.id

string

required

customer.name

string | null

required

customer.email

string | null

required

customer.avatar

string | null

required

customer.externalId

string | null

required

sale

object

required

Show child attributes

sale.amount

number

required

sale.currency

string

required

sale.paymentProcessor

string

required

sale.invoiceId

string | null

required

sale.metadata

object | null

required

Show child attributes

sale.metadata.{key}

any