Cart Data Reference
Cart events contain key transactional moments in an online purchasing process. The payload contains information including the customer, product, price, and subscription.
Payload
The payload below is a representation of a Cart trigger.
The payload is based on a cart.checkout status, but it is relevant for all Cart trigger statuses. See the Workflow Events/Triggers article for a full list of available events.
{
"_id": "cart_id",
"organization": "your_org",
"lineItems": [
{
"id": "item_id",
"listPrice": 999,
"name": "Health Boost Plan 90-Day",
"description": "A three-month starter plan for new users, offering a discounted rate for the initial commitment period. Standard monthly pricing applies after the third month.",
"price": 599,
"quantity": 1,
"optionId": null,
"optionLabel": null,
"optionType": null,
"productId": "product_id",
"contradictingProducts": [],
"url": null,
"isSubscription": true,
"subscriptionPhases": [
{
"price": 599,
"cycles": "1",
"requirements": [
{
"type": "qnr",
"key": "intake_form"
},
{
"type": "qnr",
"key": "health_history"
},
{
"type": "qnr",
"key": "photo_id"
},
{
"type": "qnr",
"key": "selfie_photo"
},
{
"type": "qnr",
"key": "consent_telehealth"
}
],
"fillingCycleInterval": 4,
"fillingCycleUnit": "week",
"billableCycleInterval": 1
},
{
"price": 0,
"cycles": "2",
"requirements": [
{
"type": "qnr",
"key": "monthly_checkin"
},
{
"type": "qnr",
"key": "progress_photo"
}
],
"fillingCycleInterval": 4,
"fillingCycleUnit": "week",
"billableCycleInterval": 1
},
{
"price": 299,
"cycles": 0,
"requirements": [
{
"type": "qnr",
"key": "monthly_checkin"
},
{
"type": "qnr",
"key": "progress_photo"
}
],
"fillingCycleInterval": 4,
"fillingCycleUnit": "week",
"billableCycleInterval": 1
}
],
"extras": {
"Note": "Pharmacies were set to 'PENDING' to prevent automatic order fulfillment.",
"pharmacies": {
"PharmacyA": "PENDING",
"PharmacyB": "PENDING"
},
"bigcommerceId": null,
"stripePriceId": null,
"includeInjectionKit": [
"StarterKit"
]
},
"type": "physical",
"options": [],
"relatedProducts": [],
"subLabel": "$599/3mo, renews $299/mo",
"categories": [
"78715b7ca01a82fa653bf47f",
"78717f893738e5736a648c74"
]
}
],
"paymentIntentId": null,
"createdAt": "2024-06-25T11:45:10.550Z",
"updatedAt": "2024-06-25T11:45:10.550Z",
"__v": 0,
"baseAmount": 999,
"subTotalAmount": 599,
"totalAmount": 599,
"discountAmount": 0,
"postPurchaseCredit": 0,
"customer": {
"_id": "customer_id",
"email": "janedoe@email.com",
"phone": "+15551234567",
"firstName": "Jane",
"lastName": "Doe"
}
}Parameter Descriptions
The table below describes the parameters of the payload.