Kartra Documentation TECHNICAL DOCUMENTATION

If a subscription is cancelled

Below is the data that is being pinged by our api system when a subscription is cancelled.

Parameters Values
lead
{
    "id": integer,
    "first_name": string,
    "middle_name": string,
    "last_name": string,
    "last_name2": string,
    "email": string,
    "phone_country_code": string,
    "phone": string,
    "company": string,
    "address": string,
    "city": string,
    "zip": string,
    "state": string,
    "country": string,
    "date_joined": string (YYYY-mm-dd hh:mm:ss),
    "website": string,
    "ip": string,
    "ip_country": string,
    "facebook": string,
    "twitter": string,
    "linkedin": string,
    "google_plus": string,
    "sales_tax_id": string,
    "lead_picture": string,
    "source": string,
    "score": integer,
    "lead_deleted": integer,
    "lead_deleted_date": string (YYYY-mm-dd hh:mm:ss),
    "referring_id": integer, 
    "blacklisted": integer,    
    "source_id": integer,
    "gdpr_lead_status": integer,
    "gdpr_lead_status_date": string,
    "gdpr_lead_status_ip": string,
    "gdpr_lead_communications": integer,
    "custom_fields": [
	{
	    "field_id":integer,
	    "field_identifier":string,
	    "field_type":string,
	    // In the case of input_field and text_area this will be string, else it will have the following structure:
	    "field_value":[
		{
	            "option_id":integer,
		    "option_value":string,
		},
		{
		    "option_id":integer,
		    "option_value":string,
		}
	    ]
	}
    ]
}
  • id: A unique numeric identifier for the lead.
  • first_name: The lead’s first name.
  • last_name: The lead’s last name.
  • email: The lead’s email address.
  • gdpr_lead_status: The lead’s GDPR status, possible values:
    0 – For GDPR status off – Your account has GDPR deactivated
    1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
    2 – For GDPR status accepted – The lead has accepted the GDPR terms
    3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
    4 – For GDPR status unknown – The lead’s location could not be determined
    5 – For GDPR status pending
  • gdpr_lead_status_date: The date of the last GDPR status change
  • gdpr_lead_status_ip: The IP of the last GDPR status change
  • gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
  • custom fields:
    • field_id – the unique id reference (integer)
    • field_identifier – the unique identifier chosen when it was created (string)
    • field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
    • field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array . In the case of checkboxes the values can have multiple values:
    • [
      	{
      		"option_id":1, // the unique id reference (integer)
      		"option_value":"red", // option value (string)
      	},
      	{
      		"option_id":integer,
      		"option_value":string,
      	}
      ]
action
  • cancel_subscription
action_details
{
        "transaction_details":{
        "transaction_id":integer,
        "buyer_first_name":string,
        "buyer_last_name":string,
        "buyer_email":string,
        "buyer_username":string,
        "buyer_id":integer,
        "product_name":string,
        "product_id":integer,
        "product_price_point":integer,
        "transaction_date":date(Y-m-d H:i:s),
        "transaction_type":"cancellation",
        "transaction_subscription_id":integer,
        "original_id":integer,
        "buyer_billing_country":string,
        "buyer_billing_state":string,
        "buyer_billing_phone_country_code":string,
        "buyer_billing_phone_number":string,
        "buyer_billing_address":string,
        "buyer_billing_city":string,
        "buyer_billing_zip":string,
        "payment_processor_type": string
    }
}
  • transaction_id: Kartra order id.
  • buyer_first_name: The buyer first name.
  • buyer_last_name: The buyer last name.
  • buyer_email: The buyer email address.
  • buyer_username: The buyer username.
  • buyer_id: A unique numeric identifier for the lead id.
  • product_name: The product name.
  • product_id: A unique numeric identifier for the kartra product.
  • product_price_point: The product price point of the transaction.
  • transaction_date: The date of the transaction (Y-m-d H:i:s).
  • transaction_type: cancellation
  • transaction_parent_id: 0
  • transaction_subscription_id: A unique numeric identifier for the subscription id(if there is no recurring payments this will be 0).
  • transaction_subscription_pay_number: 1
  • original_id: In case of a payment subscription, the order ID of the first transaction within the subscription.
  • buyer_billing_country: The buyer country.
  • buyer_billing_state: The buyer state.
  • buyer_billing_phone_country_code: The buyer phone country code.
  • buyer_billing_phone_number: The buyer phone number.
  • buyer_billing_address: The buyer address.
  • buyer_billing_city: The buyer city.
  • buyer_billing_zip: The buyer zip code.
  • payment_processor_type: The payment processor type: “PayPal”, “Braintree”, “Stripe”, “Authorize.net”

© 2020 Kartra All Rights Reserved