ARBUpdateSubscription
Use this procedure to update an existing Automated Recurring Billing (ARB) subscription. Only the fields you provide are updated.
Stored Procedure-Specific Information
To execute this stored procedure, enter:EXEC ARBUpdateSubscription SubscriptionId='1234567', Amount='30.00'
Input
| Name | Type | Required | Description |
| RefId | String | False | Merchant-assigned reference ID for the request. If included, this value is returned in the response. |
| SubscriptionId | String | True | The payment gateway assigned identification number of the subscription to update. |
| SubscriptionName | String | False | Merchant-assigned name for the subscription. |
| StartDate | Date | False | The date the subscription begins, in YYYY-MM-DD format. Can only be updated if no successful payments have been completed. The billing interval cannot be changed after the subscription is created. |
| TotalOccurrences | Integer | False | Number of billing occurrences or payments for the subscription. Use 9999 to indicate an ongoing subscription without an end date. |
| TrialOccurrences | Integer | False | Number of billing occurrences or payments in the trial period. Can only be updated if the subscription has not begun or is still in the trial period. |
| Amount | Decimal | False | The amount to be billed to the customer for each payment. This is the total amount and must include tax, shipping, and any other charges. |
| TrialAmount | Decimal | False | The amount to be charged for each payment during a trial period. |
| CardNumber | String | False | The customer's credit card number. Required, together with ExpirationDate, to update the payment method to a new credit card. Do not specify together with RoutingNumber/AccountNumber/NameOnAccount or CustomerProfileId/CustomerPaymentProfileId, which update to a new bank account or an existing customer profile instead. |
| ExpirationDate | String | False | The expiration date of the credit card, in YYYY-MM format. Required, together with CardNumber, to update the payment method to a new credit card. Do not specify together with RoutingNumber/AccountNumber/NameOnAccount or CustomerProfileId/CustomerPaymentProfileId, which update to a new bank account or an existing customer profile instead. |
| CardCode | String | False | The three- or four-digit card verification code. Used only for validation; it is not stored. |
| BankAccountType | String | False | The type of bank account used to update the payment method. Required, together with RoutingNumber, AccountNumber, and NameOnAccount, to update to a new bank account instead of a credit card. Possible values are checking, savings, and businessChecking. |
| RoutingNumber | String | False | The ABA routing number of the bank account used to update the payment method. Required, together with AccountNumber and NameOnAccount, to update to a new bank account instead of a credit card. |
| AccountNumber | String | False | The account number of the bank account used to update the payment method. Required, together with RoutingNumber and NameOnAccount, to update to a new bank account instead of a credit card. |
| NameOnAccount | String | False | The name of the person who holds the bank account used to update the payment method. Required, together with RoutingNumber and AccountNumber, to update to a new bank account instead of a credit card. |
| EcheckType | String | False | The type of eCheck transaction. Do not use TEL, ARC, or BOC for recurring charges. Possible values are PPD, WEB, or CCD. |
| BankName | String | False | The name of the bank associated with the bank account used to update the payment method. |
| OpaqueDataDescriptor | String | False | The nonce data descriptor that identifies how the payment nonce in OpaqueDataValue was generated. Required, together with OpaqueDataValue, to update the payment method to a payment nonce instead of a credit card, bank account, or existing customer profile. |
| OpaqueDataValue | String | False | The payment nonce used to update the payment method. Required, together with OpaqueDataDescriptor, to update the payment method to a payment nonce instead of a credit card, bank account, or existing customer profile. |
| OrderInvoiceNumber | String | False | Merchant-assigned invoice number for the subscription order. |
| OrderDescription | String | False | Description of the subscription order. |
| CustomerType | String | False | The type of customer associated with the subscription. Possible values are individual and business. |
| CustomerId | String | False | Merchant-assigned identifier for the customer associated with the subscription. |
| CustomerEmail | String | False | The customer's email address. |
| CustomerPhoneNumber | String | False | The customer's phone number. |
| CustomerFaxNumber | String | False | The customer's fax number. |
| BillToFirstName | String | False | First name associated with the customer's billing address. |
| BillToLastName | String | False | Last name associated with the customer's billing address. |
| BillToCompany | String | False | Company name associated with the customer's billing address. |
| BillToAddress | String | False | Street address associated with the customer's billing address. |
| BillToCity | String | False | City associated with the customer's billing address. |
| BillToState | String | False | State associated with the customer's billing address. |
| BillToZip | String | False | Postal code associated with the customer's billing address. |
| BillToCountry | String | False | Country associated with the customer's billing address. |
| ShipToFirstName | String | False | First name associated with the customer's shipping address. |
| ShipToLastName | String | False | Last name associated with the customer's shipping address. |
| ShipToCompany | String | False | Company name associated with the customer's shipping address. |
| ShipToAddress | String | False | Street address associated with the customer's shipping address. |
| ShipToCity | String | False | City associated with the customer's shipping address. |
| ShipToState | String | False | State associated with the customer's shipping address. |
| ShipToZip | String | False | Postal code associated with the customer's shipping address. |
| ShipToCountry | String | False | Country associated with the customer's shipping address. |
| CustomerProfileId | String | False | The payment gateway assigned identification number of an existing customer profile to bill for the subscription. Required, together with CustomerPaymentProfileId, to update to an existing customer profile. Do not specify together with CardNumber/ExpirationDate or RoutingNumber/AccountNumber/NameOnAccount, which update to a new credit card or bank account instead. If included, this value is returned in the response. |
| CustomerPaymentProfileId | String | False | The payment gateway assigned identification number of an existing customer payment profile to bill for the subscription. Required, together with CustomerProfileId, to update to an existing customer profile. Do not specify together with CardNumber/ExpirationDate or RoutingNumber/AccountNumber/NameOnAccount, which update to a new credit card or bank account instead. If included, this value is returned in the response. |
| CustomerAddressId | String | False | The payment gateway assigned identification number of an existing customer shipping address to associate with the subscription. Applies only when CustomerProfileId is specified. If included, this value is returned in the response. |
Result Set Columns
| Name | Type | Description |
| RefId | String | Merchant-assigned reference ID for the request. |
| ResultCode | String | Overall status of the request. Possible values are Ok and Error. |
| Code | String | Response code that represents the status. |
| Message | String | Text description of the status. |
| CustomerProfileId | String | The identifier of the customer profile associated with the subscription. |
| CustomerPaymentProfileId | String | The identifier of the payment profile associated with the subscription. |
| CustomerAddressId | String | The identifier of the customer shipping address associated with the subscription. |