Skip to content

purchase.completed

POST

Fires, when user has completed a purchase or when recurrent/upsell purchase happens.

Media typeapplication/json
object
id
required
string

Example: evt_00000000000000000000000000

type
required
string
created_at
required

UNIX timestamp in seconds

integer format: int64
location
required
object
Show 10 propertiesHide properties
funnel_id
required
string
funnel_version
required
integer
origin
required
string
query
required
string
query_params
required
object
Show 1 propertyHide property
key
additional properties
string
sandbox
required
boolean
onboarding
string
experiment_id
string
experiment_title
string
experiment_alias
string
profile
required
object
Show 12 propertiesHide properties
id
required
string

Example: pro_00000000000000000000000000

session_id
required
string

Example: ses_00000000000000000000000000

email
required

User email address

string format: email

Example: me@example.com

country
required
string

Example: GB

ip
required
string

Example: 00.00.000.00

city
required
string

Example: Birmingham

region_code
required

Region or state code, null when geo data is unavailable

string
nullable

Example: FL

postal_code
required

Postal code, null when geo data is unavailable

string
nullable

Example: 33028

time_zone
required
string

Example: Europe/London

user_agent
required
string

Example: Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)

locale
required

Locale name

string

Example: 🇪🇸 Spanish

locale_code
required

Locale code

string

Example: en_US

funnel_id
string

Example: 00000000000000000000000000

profile_id
string

Example: pro_00000000000000000000000000

project_id
required
string

Example: 00000000000000000000000000

is_sandbox
required
boolean

Example: false

session_id
required
string

Example: ses_00000000000000000000000000

data
required
object
data
required
object
Show 14 propertiesHide properties
id
required
string

Example: tra_00000000000000000000000000

created_at
required

UNIX timestamp in seconds

integer format: int64

Example: 1716672462

profile_id
required
string

Example: pro_00000000000000000000000000

is_sandbox
required
boolean

Example: false

session_id
required
string

Example: ses_00000000000000000000000000

currency
required
string

Example: USD

price
required
integer

Example: 1099

subscription
object
Show 4 propertiesHide properties
subscription_id
required
string

Example: sub_00000000000000000000000000

vendor_subscription_id
required
string

Example: sub_XXXXXXXXXXXXXXXXXXXXXXXX

starts_at
required

UNIX timestamp in seconds

integer format: int64

Example: 1716672462

ends_at
required

UNIX timestamp in seconds

integer format: int64

Example: 1716672462

vendor
required

Payment provider the transaction belongs to: stripe, paddle, paypal, solidgate, fastspring, or funnelfox-billing for FunnelFox Payments. Custom payment provider integrations send their own value.

string

Example: stripe

vendor_discount_id
string

Example: dsc_XXXXXXXXXXXXXXXXXXXXXXXXXX

vendor_price_id
string

Example: price_XXXXXXXXXXXXXXXXXXXXXXXX

vendor_product_id
string

Example: prod_XXXXXXXXXXXXXX

vendor_profile_id
required
string

Example: cus_XXXXXXXXXXXXXX

vendor_transaction_id
required
string

Example: in_XXXXXXXXXXXXXXXXXXXXXXXX

200 Event received successfully

Section titled “200”