You are here: API Reference > Calls > subscribe

subscribe

The subscribe call is a combined call that you can use to do all of the following in a single call. This call bundles up all the information needed to create one or more new subscriptions.

Syntax and Argument

subscribe(SubscribeRequest[])

The argument is as shown in the following table. For information on the field types, see Field Types.

Argument Description
SubscribeRequest[] An array of one or more objects of type zObject.

Using This Call

This call performs a large number of actions. It takes in an array of SubscribeRequests. Because it takes an array, you can submit a batch of subscription requests at once. Note that If the effective date is in the future there won't be any invoice generation, and hence there will be no invoice number.

Important!

Both the create and subscribe calls will create a new account; however, there are differences.

Response

Returns an array of SubscribeResult.

Faults

UnexpectedErrorFault

Sample Code

See the reference implementation.

See also

Invoking the subscribe Call

SubscribeRequest

SubscribeResult

Copyright © 2008-2009 Zuora, Inc.