Orders taken through the Limio Shop and Limio Self-Service integrates off-the-shelf with Zuora. What this means in practice is that when customers place a New Order, a Switch Order, a Cancel Order, a Cancel/Save Order, or a Payment Added, we create an Event in Limio. This event has a Process Event which updates the Zuora data model.
Details button - next window
Zuora API, objects and fields
The process event call outs to the Zuora REST API and will create the following objects:
Customer journey |
Limio event |
Zuora |
New purchase |
Order Submitted |
Order > Create Subscription |
Switch offer (Upgrade/downgrade) |
Order Change Offer |
Order > Update Terms and Conditions + Order > Remove Product + Order > Add Product |
Cancel Save |
Order Add Offer |
Order > Add Product (Discount product) |
Cancel |
Order Cancel Subscription |
Order > Cancel Subscription |
Renew | Order Renew | Order > Renew Subscription |
Refund |
Order Refund |
Payments > Zuora Refunds |
Change of address |
Order Change Address |
Customer Account > Sold To or Bill To address |
Change of payment method |
Order Change Payment |
Customer Account > New Payment Method |
Each event will have its own payload, available via webhooks. Limio will automatically populate the Zuora Order standard fields, as defined here. Zuora will then update the Customer, Subscription, Payments etc… as defined in their documentation.
If you have any questions, please contact us at support@limio.com
---
Example of a new purchase payload:
{
"source":"salesforce",
"__spec_version":"2",
"process_immediately":false,
"mode":"production",
"external_id":"2V44IEVMFOT",
"tracking":{
"accountId":"0015400000k3Y70AAE",
"contactId":"0035400000kbH8CAAU",
"caseId":"50054000008c7rA",
"userId":"005000000000000000",
"offers":[
"/offers/The test Bundles - UK-UK/Quarterly"
],
"campaign":"/offers/The test Bundles - UK-UK",
"purchaseCountryCode":"GB"
},
"orderItems":[
{
"name":"Quarterly",
"price":{
"currency":"GBP",
"amount":25,
"summary":{
"headline":"<p>12 weeks for <s>£55.00</s> £25.00</p>",
"subline":"<p>Auto-renewing at £55.00 quarterly.</p>"
}
},
"offer":{
"path":"/offers/The test Bundles - UK-UK/Quarterly",
"data":{
"associations":{
"exchange":[
"/offers/The test Full Price - UK-UK"
]
},
"price__limio":[
],
"attachments":[
{
"path":"/assets/Images/test Digital Print",
"name":"test Digital Print",
"type":"image/png",
"url":"/public/0b794df4-bd9b-49f4-94f0-51cf936beb14/201103 FCX Digital offer lock up.png"
}
],
"created":"2020-09-11T15:12:50+00:00",
"type":"item",
"duplicatedFrom":"/offers/The test Bundle - UK-UK/Quarterly",
"record_type":"offer",
"tags":[
"/tags/uk-uk/bundle"
],
"products":[
{
"baseTemplate":"/config/templates/products/ProductBase",
"path":"/products/test/Digital Premium",
"created":"2020-11-09T15:55:28+00:00",
"name":"Digital Premium",
"modified":"2021-02-02T16:10:39+00:00",
"attributes":{
"block_multiple__limio":true,
"product_code__limio":"TE.DIGITAL"
},
"type":"item",
"record_type":"product"
}
],
"segments":[
],
"baseTemplate":"/config/templates/offers/OfferBase",
"path":"/offers/The test Digital - UK-UK/Quarterly",
"priceReference":"/offers/The test Digital - UK-UK/Quarterly",
"price":[
],
"name":"The test Bundles - UK-UK",
"modified":"2020-11-21T14:30:00+00:00",
"attributes":{
"price__limio":[
{
"delay_interval_type":"weeks",
"subscription_start_day":"",
"label":"Charge 1",
"trigger":"subscription_start",
"repeat_count":1,
"type":"recurring",
"name":"charge_1",
"repeat_interval":12,
"attributes":[
],
"repeat_interval_type":"weeks",
"value":"25",
"currencyCode":"GBP"
}
],
"OfferCurrencyCountry":[
"United Kingdom"
],
"valid_date_range__limio":{
"from":"2020-09-13T16:30:55.297Z",
"to":"2020-10-01T16:30:59.747Z"
},
"term__limio":{
"length":12,
"type":"weeks"
},
"display_price__limio":"<p>12 weeks for <s>£55.00</s> £25.00</p>",
"cta_text__limio":"Subscribe",
"primary_color__limio":"#f47373",
"sales_channel__limio":[
"Online",
"Salesforce"
],
"rate_plan__zuora":"UK-UK A Quarterly",
"trial__limio":true,
"display_name__limio":"Quarterly",
"group__limio":"digital",
"meta_title__limio":"Subscribe",
"best_value__limio":true,
"tertiary_color__limio":"#020109",
"checkout__limio":{
"checkout_type":"external",
"external_url":"https://fcxdev.test.com/s/authentication?starturl={{origin}}%2Fcheckout"
},
"student__limio":false,
"display_description__limio":"",
"autoRenew__limio":true,
"description__limio":"",
"allowed_countries__limio":[
"AT",
"BE",
"BG",
"HR",
"CY",
"CZ",
"DK",
"EE",
"FI",
"FR",
"DE",
"GI",
"GR",
"HU",
"IS",
"IE",
"IT",
"LV",
"LI",
"LT",
"LU",
"MT",
"NL",
"NO",
"PL",
"PT",
"RO",
"SK",
"SI",
"ES",
"SE",
"GB"
],
"Currency Country":[
"United Kingdom"
],
"sales_channel":[
"Online",
"Salesforce"
],
"cta__limio":"Subscribe",
"secondary_color__limio":"#0e4f1b",
"payment_types__limio":[
"zuora_paypal",
"zuora_card"
],
"offer_features__limio":"<p>test app and test.com</p><p>Digital newsletters</p><p>Audio version & podcasts</p><p>The archive</p><p>Cancel anytime</p>",
"detailed_display_price__limio":"<p>Auto-renewing at £55.00 quarterly.</p>",
"push_to_checkout__limio":true,
"offer_type__limio":"trial"
},
"parent_path":"/offers/The test Digital - UK-UK",
"status":"draft"
},
"name":"Quarterly",
"parent_path":"/offers/The test Bundles - UK-UK",
"id":"c4d81f46a9189f1b536f12faefbde3085e29b633.97d170e1550eee4afc0af065b78cda302a97674c",
"type":"item",
"tracking":{
"searchCountryCode":"GB"
}
},
"products":[
{
"baseTemplate":"/config/templates/products/ProductBase",
"path":"/products/test/Digital Premium",
"created":"2020-11-09T15:55:28+00:00",
"name":"Digital Premium",
"modified":"2021-02-02T16:10:39+00:00",
"attributes":{
"block_multiple__limio":true,
"product_code__limio":"TE.DIGITAL"
},
"type":"item",
"record_type":"product"
}
],
"quantity":1,
"startDate":"2021-11-02"
}
],
"total":{
"currency":"GBP",
"amount":25
},
"customerDetails":{
"firstName":"Giacomo",
"lastName":"Dorandini",
"email":"giacomo-test@oct-11-limio.com"
},
"payment":{
"type":"zuora",
"zuora":{
"redirectUrl":"https://java-saas-5239-dev-ed.lightning.force.com/callback",
"signature":"Hunu7aDVZ4d7iCUVL1Adh9kUuLAcACs1kqfAAK/3ZI7MFJm+/T+n8pB2Wbvh5vgp1vjh3yMj50yj7XZ6qO8iuXfaNaEpkoqPAilFQYJeddTdAlXcLxZStP1XHmd2XTSWJpEKVUeu9/syUrT7XbVhK8LP5Jn/hcRjl+Ya6WyR2blmSNq/v6P9n4d5gQG8l1a2aZ1aCH39Rj16XWazuixqgBcVyszMTiZeaCjc7LsH40Hnx/Mi/SYoXbeKg2OC9uaQhLoIfC/BVIoYqBAGn+6xmhEeMKfchyHxfQUskPcQBub6GVnVMSVeEKB83ZO52ow8VKm0j+rzAtIpJfz/7J03Og==",
"success":"true",
"responseFrom":"Response_From_Submit_Page",
"refId":"8adca41e7c7cf49c017c84948c906d5e",
"token":"FjfRWTjVu0uTtQi8U0V6sXMs10J1hKUN"
}
},
"country":"GB",
"sourceDetails":{
}
}
--
Comments
0 comments
Please sign in to leave a comment.