On This Page

Fields for a Subscription Cancellation Request

This table describes the required and optional fields for specifying a subscription cancellation request.
Field names are listed in the table as they appear in batch file templates. An asterisk after a field name indicates that the field is required for an authorization request. When you create a batch file based on a template, remove any asterisks from field names.
Fields in a Data Record for a Subscription Cancellation Request
Column
Field Name
Description
Required?
Data Type
Length
A
merchantReferenceCode
*
Merchant-generated order reference or tracking number.
Required
String
50
B
recurringSubscriptionInfo_subscriptionID*
Subscription ID that is returned to you when a subscription is created. Include this field in your request when you update a subscription or an individual payment, or when you retrieve subscription information. Also see Processing a Payment or Credit with a Subscription for information about using a subscription ID when initiating a one-time payment or credit.
Required
String
26
C
recurringSubscriptionInfo_status*
Status of the subscription. Set this field to cancel to cancel the future scheduled payments for an installment or recurring subscription.
Required
String
15
RELATED TO THIS PAGE