2012

Table Of Contents

SOAP API Developer Reference August 2012 217

Recurring Payments and Reference Transactions API Operations

ManageRecurringPaymentsProfileStatus API Operation

The ManageRecurringPaymentsProfileStatus API operation cancels, suspends, or

reactivates a recurring payments profile.

ManageRecurringPaymentsProfileStatus Request Message

NOTE: Not all fields shown are available for use. Use only the fields described in the

documentation.

ManageRecurringPaymentsProfileStatus Request Fields

Field Description

ProfileID xs:string

(Required) Recurring payments profile ID returned in the

CreateRecurringPaymentsProfile response.

Character length and limitations: 14 single-byte alphanumeric characters. 19

character profile IDs are supported for compatibility with previous versions of the

PayPal API.

Action ns:StatusChangeActionType

(Required) The action to be performed to the recurring payments profile. Must be one

of the following:

 Cancel – Only profiles in Active or Suspended state can be canceled.

 Suspend – Only profiles in Active state can be suspended.

 Reactivate – Only profiles in a suspended state can be reactivated.

Note xs:string

(Optional) The reason for the change in status. For profiles created using Express

Checkout, this message is included in the email notification to the buyer when the

status of the profile is successfully changed, and can also be seen by both you and the

buyer on the Status History page of the PayPal account.