SubscribeWithExistingAccount

From API Documentation

Jump to: navigation, search

NOTE: subscribeWithExistingAccount() is deprecated in versions 11.0+. Please use subscribe() to create subscriptions for accounts that already exist if you are using version 11.0+.

If you have already created an account, use this call to create a subscription for that account. The call takes an account ID, creates a new subscription, and, optionally, generates an invoice on that account and applies a payment immediately.

Note: If you use this call on an account with an existing subscription, the new subscription will be created and, if options are set to generate an invoice and apply payment, the invoice will include outstanding charges for all existing subscriptions for that account (including the previous subscriptions as well as the new one being created).

The payment would then be applied to the outstanding balance for the newly created invoice.

Syntax and Argument

subscribeWithExistingAccount(SubscribeWithExistingAccountRequest[])

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

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

Using This Call

There are two common scenarios for which you may wish to use this call:

  • The most common use case is if one of your customers has created an account for a free trial and now wants to activate that subscription. Use this call to activate the subscription, provide payment information, and apply a payment.
  • A second less common case is to create a second subscription for an existing account.

See Also