Tracking cancellations
This call will mark the customer as cancelled and will decrease the MRR generated by him/her.
POST https://firstpromoter.com/api/v1/track/cancellation
curl --request POST \
--url https://firstpromoter.com/api/v1/track/cancellation \
--header 'X-API-KEY: <api-key>'
{
"id": 33848911,
"type": "cancellation",
"amount_cents": null,
"reward": null,
"lead": {
"id": 20738339,
"state": "cancelled",
"email": "[email protected]",
"uid": null,
"customer_since": "2024-09-11T14:22:12.160Z",
"cancelled_at": "2024-09-11T15:07:46.174Z",
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-09-09T16:22:44.168Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"promoter": {
"id": 3920164,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2022-04-26T15:28:24.800Z",
"temp_password": "xxxxxxxxxx",
"default_promotion_id": 4210919,
"pref": "db1znwe",
"default_ref_id": "8yi2epelut",
"note": "This is a note",
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 577918,
"earnings_balance": {
"cash": 50744
},
"current_balance": {
"cash": 20044
},
"paid_balance": {
"cash": 30700
},
"auth_token": "xxxxxxxxxxxxxx"
}
}
Authorizations
Query Parameters
required if uid is null
Email of the lead/sign-up
required if email is null
uid of the lead added on signup tracking
Response
33848911
"cancellation"
null
null
20738339
"cancelled"
null
"2024-09-11T14:22:12.160Z"
"2024-09-11T15:07:46.174Z"
null
"no_suspicion"
null
null
"2024-09-09T16:22:44.168Z"
null
null
null
null
ID of the promoter
3920164
Status of the promoter
"active"
""
Email of the promoter
ISO date of when the promoter was created
"2022-04-26T15:28:24.800Z"
Temporary password created for the promoter
"xxxxxxxxxx"
4210919
"db1znwe"
Default referral id of the promoter
"8yi2epelut"
A note/description of promoter
"This is a note"
Url of the w8 form
null
Url of the w9 form
null
Parent promoter id
577918
Earning balance of the promoter
50744
Current balance of the promoter
20044
Paid balance of the promoter
30700
Authentication token generated when the promoter was created
"xxxxxxxxxxxxxx"
curl --request POST \
--url https://firstpromoter.com/api/v1/track/cancellation \
--header 'X-API-KEY: <api-key>'
{
"id": 33848911,
"type": "cancellation",
"amount_cents": null,
"reward": null,
"lead": {
"id": 20738339,
"state": "cancelled",
"email": "[email protected]",
"uid": null,
"customer_since": "2024-09-11T14:22:12.160Z",
"cancelled_at": "2024-09-11T15:07:46.174Z",
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-09-09T16:22:44.168Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"promoter": {
"id": 3920164,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2022-04-26T15:28:24.800Z",
"temp_password": "xxxxxxxxxx",
"default_promotion_id": 4210919,
"pref": "db1znwe",
"default_ref_id": "8yi2epelut",
"note": "This is a note",
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 577918,
"earnings_balance": {
"cash": 50744
},
"current_balance": {
"cash": 20044
},
"paid_balance": {
"cash": 30700
},
"auth_token": "xxxxxxxxxxxxxx"
}
}