SubscribeResult

This object provides the results of a subscribe request.

Syntax

SubscribeResult[] = subscribe(SubscribeRequest[])

For information on the field types, see Field Types.

Name	Type	Allowable Values	Description
AccountId	zns: ID	This field is not editable	The system-generated Zuora ID for the created account.
AccountNumber	string	This field is not editable	The account number.
Errors	An array of type Error	This field is not editable	An array of errors denoting why the subscribe request may have failed.
InvoiceData	A wrapper for an invoice and its line items	This field is not editable	Only returned when using preview mode for subscribe().
InvoiceId	zns: ID	This field is not editable	The system-generated Zuora invoice ID associated with the subscription.
InvoiceNumber	string	This field is not editable	An invoice number associated with the subscription.
InvoiceResult	zns:ID, string	InvoiceID, InvoiceNumber	The collection of all invoices generated within the subscribe call. The Invoice ID and invoice number are shown for each invoice within invoice result. This field was added in version 30.
PaymentTransactionNumber	string	This field is not editable	A payment transaction number associated with this subscription.
SubscriptionId	zns: ID	This field is not editable	An identification number for the subscription.
SubscriptionNumber	string	This field is not editable	A number for the subscription.
Success	boolean	This field is not editable	Indicates whether the subscribe request succeeded (true) or did not succeed (false).