Create an Account with Mailchimp or Login to Existing
Create a new API Key in account settings
Create a List ID, also known as Audience ID
Connect to Subrise
Receive Subrise Data to Mailchimp!
Event Types and Payloads
The Subrise Subscription application, will send subscription-based data to your Mailchimp account for a variety of different Events. Below are the following Events you can expect to receive data for, as well as the format of that data.
Events
New Subscription Payload
Copy {
metric: "subrise_new_subscription",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
subscription_line_items: [
{
variant_title: blue shirt,
price: 1.99,
quantity: 1,
discounted_price: 1.99,
},
],
total_subscription_price: 1.99,
subscription_started_date: "2024-05-14T17:52:47.910Z",
}
New Subscriber Payload
Copy {
metric: "subrise_new_subscriber",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
subscription_total: 1.99,
subscription_started: "2024-05-14T17:52:47.910Z",
subscription_line_items: [
{
variant_title: blue shirt,
price: 1.99,
quantity: 1,
discounted_price: 1.99,
},
]
}
Subscription Cancelled Payload
Copy
{
metric: "subrise_subscription_cancelled",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
reason: "too good",
reason_details: "The deal was too good",
total_subscription_orders: 1,
subscription_cancelled_date: "2024-05-14T17:52:47.910Z",
}
Subscription Modified
updatedField, and updatedValue will correspond to the different fields that may or may not get updated on a Subscription object.
Copy
{
metric: "subrise_subscription_modified",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
subscription_modified_date: "2024-05-14T17:52:47.910Z",
updatedField1: "deliveryInterval",
updatedValue1: "MONTH",
updatedField2: "deliveryIntervalCount",
updatedValue2: 1,
updatedField3: "billingInterval".
updatedValue3: "MONTH",
updatedField4: "billingIntervalCount",
updatedValue4: 1,
updatedField5: "maxCycles",
updatedValue5: NULL,
updatedField6: "minCycles",
updatedValue6: NULL,
updatedField7: "isPrepaid",
updatedValue7: false,
}
Upcoming Invoice Payload
Copy
{
metric: "subrise_upcoming_invoice",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
subscription_invoice_date: "2024-05-14T17:52:47.910Z",
}
Failed Transaction Payload
Copy
{
metric: "subrise_failed_transaction",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
total_subscription_price: 1.99
failed_billing_error_message: "error",
card_info: 1234,
}
`
Successful Payment Payload
Copy
{
metric: "subrise_successful_payment",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
total_subscription_price: 1.99
payment_date: "2024-05-14T17:52:47.910Z",
}
Pause Subscription Payload
Copy {
metric: "subrise_pause_subscription",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
pause_reason: "price",
pauseDetails: "Could not afford this anymore",
total_subscription_orders: 3,
subscription_paused_date: "2024-05-14T17:52:47.910Z"
}
Reactivated Subscription Payload
Copy
{
metric: "subrise_reactivate_sub",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
total_subscription_price: 1.99
subscription_updated_date: "2024-05-14T17:52:47.910Z"
}
```
Prepaid Subscription Payload
Copy
{
metric: "subrise_prepaid_subscription",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
total_subscription_price: 1.99,
subscription_started: "2024-05-14T17:52:47.910Z",
subscription_line_items: [
{
variant_title: blue shirt,
price: 1.99,
quantity: 1,
discounted_price: 1.99,
},
]
}
```
Addon Subscription Payload
Copy {
metric: "subrise_addon_purchase",
customer_first_name: "John",
customer_last_name: "Doe",
customer_email: "johndoe@test.com",
customer_phone: "444-444-4444",
customer_id: "12345678910"
subscription_id: "12345678910",
subscription_total: 1.99,
subscription_started: "2024-05-14T17:52:47.910Z",
addon_line_items: [
{
variant_title: blue shirt,
price: 1.99,
quantity: 1,
discounted_price: 1.99,
},
]
}