SubscribeRequest
From API Documentation
Use this object with subscribe to create one or more subscriptions.
| Name | Required? | Type | Allowable Values | Description |
|---|---|---|---|---|
| Account | Yes | Object of type Account | A valid Account | This is the Account object containing the information for this particular subscription. It has all the information needed to create an account for a subscription. If you are creating the account with the subscribe() call, you will need to complete all required fields. If the account already exists, you only need to pass the ID field. |
| BillToContact | Yes if account doesn't exist, no otherwise. | Object of type Contact | A valid Contact for that account | This is the object that contains the contact associated with this account in the Account's BillToId field. |
| PaymentMethod | Yes if the account doesn't exist, no otherwise. If you are creating the account in the subscribe call, PaymentMethod must an electronic payment method and a payment gateway must be enabled. If the payment method is not an electronic payment method, create the account prior to calling subscribe(). | Object of type PaymentMethod | A valid PaymentMethod | This is the object defining the payment details for the Account. The Account will be updated with this payment as the default payment method. |
| PreviewOptions | No | Object of type PreviewOptions | true or false | Specify true to call subscribe() with preview mode. After that is completed, the call system will roll back the subscription and return only the temporary invoice data. Specfiy false to call subscribe() without preview mode.
|
| SoldToContact | No | Object of type Contact | A valid Contact | This is normally the same as BillToContact, though it can be different. If you don’t specify SoldToContact, it defaults to the information in BillToContact. |
| SubscribeOptions | No | Object of type SubscribeOptions | A valid SubscribeOptions object | This object provides two flags for determining whether to generate an invoice when the subscription is applied to the account and, if so, whether you want payments to be applied immediately. If you don't pass this object, then its two flags default to True. |
| SubscriptionData | Yes | Object of type SubscriptionData | A valid SubscriptionData | This object contains the information on the contract's dates and terms. |
