Skip to main content
Subscribe provides a mechanism to store and track the reason an AutoBill is put into a final or terminal state. Cancel reasons are codes mapped to text descriptions. You can apply one code to each AutoBill. Subscribe supports three kinds of cancel reasons:
  • Subscribe Reserved Codes—codes (0 through 99—currently only 0 through 5 are used) predefined by Vindicia and used by Subscribe to cancel or terminate a subscription
  • Predefined Merchant Codes—commonly used codes (100 through 999—currently only 100 through 107 are used) predefined by Vindicia that you can apply to AutoBills you cancel
  • Custom-Defined Merchant Codes—codes (1000 and above) that you can define and submit in advance, and use when you cancel AutoBills. Custom cancel reason codes you define can be an alphanumeric string of up to 16 characters—for example: 1001 or N500 or End_Refund.The description can be a string of up to 255 characters
The following table lists Subscribe Reserved Codes, Predefined Merchant Codes, and the numerical ranges reserved by Vindicia for future use, and for Custom-Defined Merchant Codes you create. System-generated AutoBill cancellations are automatically assigned an applicable Subscribe Reserved Code. When you cancel an AutoBill with the AutoBill.cancel method, you can apply one of the Predefined Merchant Codes, or a Custom-Defined Merchant Code you have created (see Creating Custom-Defined Merchant Cancel Reason Codes) to set the reason for the cancellation when it is submitted. The following example shows how to call the cancel method to explicitly cancel an AutoBill and apply a cancel reason code.The cancel reason code in this example could be one of the Subscribe Reserved Codes or a Custom-Defined Merchant Code you have created.
Parent topic:Canceling AutoBills