Skip to main content

Payment Method Used in the Subscribe SOAP API Call

Zuora

Payment Method Used in the Subscribe SOAP API Call

This article describes what payment method is used to pay invoices in the SOAP API subscribe() call. 

The following scenarios will be introduced on condition that the Owner Transfer feature is enabled:

  • Make a subscribe() call on a new account without specifying the Hosted Payment Method page
  • Make a subscribe() call on an existing account without specifying the Hosted Payment Method page
  • Make a subscribe() call with the Hosted Payment Method page either on a new account or an existing account

Subscribe Call on a New Account

Suppose you do not specify the Hosted Payment Method page's payment method in the subscribe() call. If you create an account in the subscribe() call, the default payment method is used to pay invoices. It does not matter whether the electronic payment method is specified or not. If the invoice owner account is specified in the subscribe() call, the default payment method of the invoice owner account is used regardless of the subscription owner account.

The following table shows what payment method and customer account are applied to invoice payment.

Scenarios Payment Method and Customer Account for Payment
  • Subscription owner account is specified
  • Invoice owner account is not specified
Default payment method of the subscription owner account
  • Subscription owner account is specified
  • Invoice owner account is specified
Default payment method of the invoice owner account

Subscribe Call on an Existing Account

Suppose you do not specify the Hosted Payment Method page's payment method in the subscribe() call. If you use an existing account and specify the electronic payment method in the subscribe() call, the electronic payment method is used to pay invoices regardless of the default payment method. Also, if the invoice owner account is specified in the subscribe() call, the payment method of the invoice owner account is used regardless of the subscription owner account.

The following table shows what payment method and customer account are applied to invoice payment. 

Scenarios Payment Method and Customer Account for Payment
  • Subscription owner account is specified
  • Invoice owner account is not specified
  • The default payment method of the subscription owner account is specified
  • The electronic payment method of the subscription owner account is specified

The electronic payment method of the subscription owner account

Note: The electronic payment method must already be associated with the subscription owner account. Otherwise, an error occurred. 

  • Subscription owner account is specified
  • Invoice owner account is not specified
  • The default payment method of the subscription owner account is specified
  • The electronic payment method of the subscription owner account is not specified
The default payment method of the subscription owner account
  • Subscription owner account is specified
  • Invoice owner account is not specified
  • The default payment method of the subscription owner account is not specified
  • The electronic payment method of the subscription owner account is specified

The electronic payment method of the subscription owner account

Note: The electronic payment method must already be associated with the subscription owner account. Otherwise, an error occurred.

  • Subscription owner account is specified
  • Invoice owner account is specified
  • The default payment method of the invoice owner account is specified
  • The electronic payment method of the invoice owner account is specified

The electronic payment method of the invoice owner account

Note: The electronic payment method must already be associated with the invoice owner account. Otherwise, an error occurred.

  • Subscription owner account is specified
  • Invoice owner account is specified
  • The default payment method of the invoice owner account is specified
  • The electronic payment method of the invoice owner account is not specified
The default payment method of the invoice owner account
  • Subscription owner account is specified
  • Invoice owner account is specified
  • The default payment method of the invoice owner account is not specified
  • The electronic payment method of the invoice owner account is specified

The electronic payment method of the invoice owner account

Note: The electronic payment method must already be associated with the invoice owner account. Otherwise, an error occurred.

Subscribe Call with the Hosted Payment Method Page 

If you specify the Hosted Payment Method page's payment method in the subscribe() call, Zuora associates this payment method with the subscription owner account. This payment method of the subscription owner account is used to pay invoices regardless of the invoice owner account and all the other payment methods.