You are here: API Reference > Objects > SubscribeOptions

SubscribeOptions

This object provides the information for SubscribeWithExistingAccountRequest, which in turn provides the information for the subscribeWithExistingAccount call.

This object provides two flags you can use when creating a subscription with the subscribeWithExistingAccount call.

The first flag, GenerateInvoice, determines whether to generate and post an invoice. If the flag is set to True, then an invoice is generated and posted.
The second flag, ProcessPayments, is related to the first. If the Account's AutoPay flag is set to True, and if GenerateInvoice is set to True, and if ProcessPayments is also set to True, then the payment is applied right away.that account. If the AutoPay flag is set to False, then no payment will be applied regardless of how the GenerateInvoice and ProcessPayments flags are set using the subscribeWithExistingAccount call.

Fields

For information on the field types, see Field Types.

Name	Required?	Type	Allowable Values	Description
GenerateInvoice	Yes	boolean	True, False	Specifies whether you want an invoice to be generated when the subscription is created. If you don't specify a value, this defaults to False.
ProcessPayments	Yes	boolean	True, False	Used when GenerateInvoice is set to True. Specifies whether you want payment to be applied when the subscription is created. If you don't specify a value, this defaults to False.