customers[]._idstringrequired
Example:ve9EPM428h8vShlRW1KT
customers[].locationIdstringrequired
Example:ve9EPM428h8vShlRW1KT
customers[].affiliateIdstringrequired
Example:ve9EPM428h8vShlRW1KT
customers[].campaignIdstringrequired
Example:ve9EPM428h8vShlRW1KT
customers[].contactIdstringrequired
Example:ve9EPM428h8vShlRW1KT
customers[].firstNamestring
Example:John
customers[].lastNamestring
Example:Doe
customers[].phonestring
Example:+15551234567
customers[].typestring
Available optionsleadcustomerdropped
Example:customer
customers[].subscriptionIdstring
Example:sub_123
customers[].dueAtstring<date-time>
Example:2026-01-01T00:00:00.000Z
customers[].deletedbooleanrequired
Whether the customer is deleted
Example:false
customers[].isDisabledbooleanrequired
Whether the customer is disabled
Example:true
customers[].createdAtstring<date-time>
Customer creation timestamp
Example:2026-01-01T00:00:00.000Z
customers[].updatedAtstring<date-time>
Customer update timestamp
Example:2026-01-01T00:00:00.000Z
customers[].campaignobject
Campaign the customer was attributed to
customers[].campaign._idstring
Example:ve9EPM428h8vShlRW1KT
customers[].campaign.namestring
Example:Summer Promo
customers[].campaign.trackTypestring
Example:funnels
customers[].campaign.currencystring
Example:USD
customers[].campaign.referralPermalinkstring
Example:P0YvWFJd8JDbFjEm2B8v
customers[].campaign.referralRealLinkstring
Referral link with the affiliate id placeholder
Example:https://example.com/payment_page?am_id=<<affiliate_id>>
customers[].campaign.domainstring
Example:https://example.com
customers[].campaign.descriptionstring
Example:Summer promo campaign
customers[].campaign.payoutFrequencystring
Example:PAY_15
customers[].campaign.commissionTypestring
Example:percentage
customers[].campaign.commissionnumber
Commission percentage or value
Example:25
customers[].campaign.commissionTiernumber
Number of commission tiers
Example:1
customers[].campaign.leadCommissionTiernumber
Number of lead commission tiers
Example:1
customers[].campaign.cookieLifenumber
Referral cookie lifetime in days
Example:365
customers[].campaign.liveModeboolean
Whether the campaign is in live mode
Example:true
customers[].campaign.deletedboolean
Whether the campaign is deleted
Example:false
customers[].campaign.createdAtstring<date-time>
Campaign creation timestamp
Example:2026-01-01T00:00:00.000Z
customers[].campaign.updatedAtstring<date-time>
Campaign update timestamp
Example:2026-01-01T00:00:00.000Z
customers[].namestring
Customer first and last name joined
Example:John Doe
customers[].revenuenumber
Total revenue attributed to this customer
Example:100
customers[].planNamestring
Comma-separated plan names the customer has commissions for
Example:Basic Plan, Pro Plan
customers[].commissionAmountnumber
Total first-tier commission earned on this customer
Example:25
customers[].currencystring
Currency of the commission amounts
Example:USD
customers[].locationCurrencystring
Default currency of the location
Example:USD