Sign In / Create an Account

Zuora Knowledge Center

Getting Started

New Features: May 2012

Zuora User Guides

Zuora API Developer's Guide

How Do I . . . ?
- How do I add custom fields to my WSDL?
- How do I allow customers to modify their stored payment methods?
- How do I allow my customers to increase or decrease the units associated with a subscription?
- How do I amend subscriptions? (Upgrades, downgrades, add-ons)
- How do I apply a credit balance if I don't use Zuora's Payment Runs?
- How do I apply a credit balance to a future invoice?
- How do I automatically notify my customers of subscriptions coming up for renewal?
- How do I avoid product proliferation when building out my product catalog?
- How do I bill a customer for a new purchase without using the default payment method in the API?
- How do I bill for recurring charges now and bill for usage later?
- How do I bill in advance?
- How do I build dashboards with Z-Force?
- How do I capture the SOAP API Request and Response?
- How do I change the currency in a customer account?
- How do I choose a payment gateway?
- How do I close my accounting period in Zuora?
- How do I communicate with customers using Zuora?
- How do I configure the frequency of the payment method updater?
- How do I configure Zuora accounting codes to classify and group transactions into a GL account in my accounting system?
- How do I control what information Zuora sends over to the payment gateway when verifying payment methods?
- How do I control when Zuora will authorize the Payment Method?
- How do I create a refund in UI and API (including shutting off a subscription)?
- How do I create an ad hoc charge or credit in Zuora?
- How do I create Journal Entries using Zuora data?
- How do I create summarized GL entries in my accounting system for Zuora transactions?
- How do I customize the invoice template to show transactions, show payments, and create a statement?
- How do I decide what authorization amount to use when configuring my payment gateway?
- How do I determine current RatePlanCharges and map back to active subscriptions?
- How do I determine if it's better to bring over summary level data or line item accounting data?
- How do I edit a merge field on the invoice template?
- How do I edit the CRM account ID for Z-Force?
- How do I expire a product so that it is no longer sold?
- How do I find out which versions of Z-Force I have installed?
- How do I find out why a payment or refund transaction failed?
- How do I fix a payment stuck in Processing status?
- How do I get self-service orders to sync to Salesforce?
- How do I give users a choice between monthly, quarterly, and annual plans?
- How do I handle a negative invoice?
- How do I handle ACH or Direct Debit payments that are reversed?
- How do I handle credit cards that have reached the maximum # of retries?
- How do I handle discounts in Zuora?
- How do I handle free trials in Zuora?
- How do I handle multi-currency in Zuora?
- How do I handle overpayments (the customer pays more than they owe)?
- How do I handle Person Accounts using Z-Force?
- How do I handle special subscription term lengths?
- How do I handle subscriptions that do not auto-renew at the end of the subscription term?
- How do I handle write-offs?
- How do I improve cash collections?
- How do I keep my tax rates updated?
- How do I know my invoice was sent to the recipient?
- How do I know what type of adjustment to use (invoice adjustment vs invoice item adjustment)?
- How do I learn about payments?
- How do I load usage information into Zuora on a regular (daily) basis?
- How do I maximize revenue using multiple gateways?
- How do I plan for internationalization in Zuora if my business wants to expand globally?
- How do I prevent customer emails from getting caught in spam/junk filters?
- How do I prevent my API user login from expiring?
- How do I prevent session tokens from expiring in the API?
- How do I prevent/reduce chargebacks?
- How do I properly cancel or downgrade customers to avoid issuing a credit or refund?
- How do I pull the detail reports that correspond to the AR by Accounting Code report?
- How do I recognize revenue with data in Zuora?
- How do I recognize revenue with Z-Suite?
- How do I redirect the email notifications for our scheduled billing and payment runs to a different email address?
- How do I remove the Zuora logo from my invoice template?
- How do I segment customers?
- How do I select from more than 15 products and rate plans when adding them to a new subscription?
- How do I set up a custom user role with permission to issue refunds and assign it to a user?
- How do I set up a monthly fee and a fee for storage?
- How do I set up a PCI compliant page to accept new payment methods?
- How do I set up a per user pricing model?
- How do I set up concurrent annual subscriptions to always bill for the full amount?
- How do I stop billing a customer who discontinued their subscription?
- How do I support compound taxation such as tax on tax in countries like Canada?
- How do I support direct debit (such as ACH) payments?
- How do I support evergreen subscriptions?
- How do I test my gateway?
- How do I troubleshoot connectivity issues?
- How do I turn on invoice editing within a customer account?
- How do I understand the "Invoice to Cash" business processes that Payment Operations supports?
- How do I understand the credit balance adjustment (CBA) data in the UI and export csv file?
- How do I understand the user actions in Payment Operations so I can build a test plan or plan an integration?
- How do I undo a change made to a subscription (delete an amendment)?
- How do I update a Bill To or Sold To address on a posted invoice?
- How do I use accounting codes?
- How do I use an invoice number to find a payment?
- How do I use batches?
- How do I use batches to optimize my billing and payments?
- How do I use custom fields?
- How do I use multiple payment gateways?
- How do I use proration in Zuora?
- How do I use the automatic price increase (uplift) feature?
- How do I use the Salesforce Sync Clean Up for my product catalog?
- How do I use the Transaction Dates from Payment Operations?
- How do I use Zuora with my existing website?
- How do I verify the charges on my invoice are correct?
- How do I view my Zuora product catalog in Salesforce?
- How do the different usage statuses impact my billing?
- How does changing the bill cycle day on a customer account impact billing for that account?
- How long do I have to refund a payment?
- How much time do I have to void a payment?
- How should I manage the credit card payment exception handling process?
- How should I think through a transactional accounting integration?

Self Implementation Portal

Page Notifications Off

Table of contents

Was this article helpful?

How do I prevent session tokens from expiring in the API?

Modified 20:53, 23 Nov 2011 by Neal Kaplan | Page History

Table of contents

1. Overview
2. Solution
3. Related

1. Overview
2. Solution
3. Related

Overview

For all Z-Commerce API calls, save the login() call, you'll need to provide a valid session token to authenticate yourself to the Zuora system. As with any session based authentication, the session token has a certain lifespan, beyond which it expires and is no longer valid. The session token can be retrieved using the login() API call. You have multiple options for managing the session tokens.

Solution

There are three ways of managing the session token:

The API client tracks the session token lifespan
The API client logs in to Zuora before every call
The API client handles session token expiration exceptions

See Logging In to the Zuora System for more information on the sequence of API calls required to retrieve a Zuora session token.

The API Client Tracks the Session Token Lifespan

The API client tracks the session token lifespan via a timer set to expire at 10 minutes. Zuora recommends that you use this method.

At the moment of timer expiration, the client logs into Zuora again, getting an updated token. This new token would be used for the next 10 minutes, and so on. The 10 minute timer duration gives a comfortable margin from the minimum Zuora session token expiration of 15 minutes.

The API Client Logs in to Zuora Before Every Call

Having the API client log in to Zuora before every call is the simplest management method. Although it incurs the overhead of another API call, it simplifies the client logic.

The API Client Handles Session Token Expiration Exceptions

When a session token expires, a Zuora API call will throw an authentication exception. The API client can then log in and re-try the call again. This is not recommended, as the exception handling logic unnecessarily complicates the API client.

Related

Tutorials

Logging In to the Zuora System (Intermediate)

Troubleshooting

Was this article helpful?: Yes No
Page statistics: 575 view(s), 8 edit(s) and 3223 character(s)

Tags

api

Comments

You must to post a comment.

Attachments