POST
/
track
/
sale
from dub import Dub
from dub.models import operations


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.track.sale(request={
        "amount": 996500,
        "payment_processor": operations.PaymentProcessor.CUSTOM,
    })

    assert res is not None

    # Handle response
    print(res)
{
  "eventName": "<string>",
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "externalId": "<string>"
  },
  "sale": {
    "amount": 123,
    "currency": "<string>",
    "paymentProcessor": "<string>",
    "invoiceId": "<string>",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

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,
polar,
paddle,
custom
​
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: 255
Example:

"Purchase"

​
invoiceId
string | null

The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID.

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

​
leadEventName
string | null

The name of the lead event that occurred before the sale (case-sensitive). This is used to associate the sale event with a particular lead event (instead of the latest lead event, which is the default behavior).

Example:

"Cloned template 1481267"

Response

200
application/json
A sale was tracked.
​
eventName
string
required
​
customer
object | null
required
​
sale
object | null
required

Was this page helpful?

Suggest editsRaise issue