Subscribed 2017: Comprehensive Overview On Fresh, New Zuora APIs
Download as PPTX, PDF1 like554 views
The document provides a comprehensive overview of new Zuora APIs, detailing the functionality of REST API calls and their use cases for web integration. It highlights features such as secure payment methods, enhanced actions for managing subscriptions and accounts, and the introduction of a simplified process for booking complex deals. Additionally, it includes guidelines for developers on how to implement various API calls and set up payment pages.
Subscribed 2017: Comprehensive Overview On Fresh, New Zuora APIs
- 2. Comprehensive Overview on Fresh New Zuora APIs Nishith Agarwal Technical Architect, Zuora
- 3. presentation agenda page 03 Demo 10:30 POSTman to send calls to Zuora API Intro 10:15 Introduce our new REST API calls, documentation and endpoints User Stories 10:40 Common use cases for web integration
- 4. presentation agenda page 04 Payment Pages 2.0 10:50 Securely capture credit card information from a website Questions Q&A 10:55
- 5. Johnny Cash Front-end Developer “Who uses SOAP anymore? Why does Zuora not provide full coverage with REST!”
- 6. We are 100% REST now!
- 7. page 07 create - create new objects in Zuora Ex. Create a new Contact for an Account update - change values of existing objects in ZuoraEx. Update address on a Contact in Zuora query - query Zuora for existing info Ex. Get a list of Accounts and related fields delete - remove existing objects from Zuora Ex. Delete an invalid credit card from the Account
- 8. Enhanced Actions page 08 Create account, contacts and subscription in a single “atomic” operation. It can optionally generate invoice and process payment immediately Subscribe Make changes to an existing subscription. We support add product, remove product, update product, suspend, resume, renew and cancel amendments Amend
- 9. Zuora Orders (Limited) page 09 You can use the Order feature to manage more complex deals. In a single Order, you can make multiple changes (amendments) to one or more subscriptions. Orders provide the Order Metrics that show the impact of the Order Actions on the included charges. ● Simplified process of booking complex deals in Zuora ● Use multiple Order Actions to describe multi-part deal structures in a single Order, making it easier to manage and report on sophisticated deals like contracted ramp. ● Enhanced booking metrics ● Order metrics, such as the change in Total Contracted Billing (TCB), change in discounted Monthly Recurring Revenue (MRR), and change in quantity are available for each charge. ● Billing tied to the whole Order ● Track downstream billing by Order so that you can readily determine the billed and unbilled amounts for easier accounting.
- 10. List of Store front calls page 010 Call Description POST /connections Connect to REST API endpoint GET /v1/catalog/products Get a tenant's entire product catalog, including rate plan and charge information GET /v1/accounts/{account-key} Get basic details for a customer account GET /v1/accounts/{account-key}/summary Get more comprehensive details (including subscription information) for a customer account POST /v1/accounts Create a new customer account (including an initial subscription, if desired) PUT /v1/accounts/{account-key} Update attributes of a customer account GET /v1/payment-methods/credit-cards/accounts/{account-key} Get all of the credit cards for a customer account POST/v1/payment-methods/credit-cards Create a new credit card for a customer account PUT /v1/payment-methods/credit-cards/{payment-method-id} Update credit card information for a customer account DELETE /v1/payment-methods/{payment-method-id} Delete a payment method for a customer account Call Description GET /v1/subscriptions/{subscription-key} Get the details for an existing subscription GET /v1/subscriptions/accounts/{account-key} Get all subscription details for a given customer account POST /v1/subscriptions Create a new subscription for an existing account POST /v1/subscriptions/preview Create a new subscription in preview mode PUT /v1/subscriptions/{subscription-key} Execute one or more amendments (10 max) on an existing subscription (property change, T&C, add, update, remove) PUT /v1/subscriptions/{subscription-key}/renew Renew an existing subscription PUT /v1/subscriptions/{subscription-key}/cancel Cancel an existing subscription
- 12. New Customers Acquire a brand new customer and capture payment method
- 13. New Customers Flow page 013 confirm order Display HPM 2.0 iFrame to securely. capture payment method information. Use subscribe request to create the Zuora account and subscription Gather account and contact details from the user to create a website login. No calls are made to Zuora at this time. add account details Get Catalog request returns a list of available products from the Zuora Product Catalog view products
- 14. Login and view existing account and subscription details from Zuora View Existing Customers
- 15. View Existing Customers Flow page 015 view invoices Get Invoices request returns past invoices including links to the invoice PDFs Get Subscription by key request returns the subscription, rate plan and charge details from Zuora view subscription Get Account Details request returns account, contact and subscription details from Zuora view account details
- 16. Watch the Demo!Let’s walk you through some API calls..
- 17. Payment Pages 2.0 Securely capture payment method information from your users. It’s PCI- compliant!
- 18. Payment Pages 2.0 - Key Features page 018
- 19. Payment Pages - Integration Steps page 019 Configure Payment Pages 2.0 Setup the Payment Pages 2.0 iFrames by logging into the Zuora UI > Payment Settings > Payment Pages. You can configure pages for credit card, ACH, SEPA and UKDD payment methods. Generate Digital Signature Use the REST API call from your server to generate a digital signature. The call takes the Zuora Tenant ID and Payment Page ID in the request and return a token and signature. Setup Javascript render and callbackUse javascript to include render and callback methods. You can pass additional parameters in the render method to pre-populate name and address information in the iFrame.
- 20. Q&A page 020
- 21. thank you.