2013

Name-Value Pair API Developer Guide February 01, 2013 155
Recurring Payments and Reference Transactions API Operations
BillOutstandingAmount API Operation
12
ManageRecurringPaymentsProfileStatus Response Message
ManageRecurringPaymentsProfileStatus Response Fields
BillOutstandingAmount API Operation
The BillOutstandingAmount API operation bills the buyer for the outstanding balance
associated with a recurring payments profile.
BillOutstandingAmount Request Message
BillOutstandingAmount Request Fields
Field Description
PROFILEID Recurring payments profile ID returned in the
CreateRecurringPaymentsProfile response. For each action, an error is
returned if the recurring payments profile has a status that is not compatible with the
action. Errors are returned in the following cases:
 Cancel – Profile status is not Active or Suspended.
 Suspend – Profile status is not Active.
 Reactivate – Profile status is not Suspended.
Field Description
METHOD (Required) Must be BillOutstandingAmount.
PROFILEID (Required) Recurring payments profile ID returned in the
CreateRecurringPaymentsProfile response.
NOTE: The profile must have a status of either Active or Suspended.
Character length and limitations: 14 single-byte alphanumeric characters. 19
character profile IDs are supported for compatibility with previous versions of the
PayPal API.
AMT (Optional) The amount to bill. The amount must be less than or equal to the current
outstanding balance of the profile. If no value is specified, PayPal attempts to bill the
entire outstanding balance amount.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).