GetRecurringPaymentsProfileDetails API Operation (SOAP)

ProfileID

xs:string

(Required) Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. 19-character profile IDs are supported for compatibility with previous versions of the PayPal API.

Character length and limitations: 14 single-byte alphanumeric characters

ProfileID

xs:string

Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.

ProfileStatus

cc:RecurringPaymentsProfileStatusType

Status of the recurring payment profile. Value is:

• Active

• Pending

• Cancelled

• Suspended

• Expired

Description

xs:string

Description of the recurring payment.

Character length and limitations: 127 single-byte alphanumeric characters

AutoBillOutstandingAmount

ebl:AutoBillType

Indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid. Value is:

• NoAutoBill — PayPal does not automatically bill the outstanding balance amount.

• AddToNextBilling — PayPal automatically bills the outstanding balance amount.

MaxFailedPayments

xs:int

Number of scheduled payments that can fail before the profile is automatically suspended.

Character length and limitations: Number string representing an integer

RecurringPayments ProfileDetails

ebl:RecurringPaymentsProfileDetailsType

Buyer information for this recurring payments profile.

CurrentRecurring PaymentsPeriod

ebl:BillingPeriodDetailsType

Details of the current subscription period. This field is not returned if the profile is canceled or expired.

RecurringPayments Summary

ebl:RecurringPaymentsSummaryDetailsType

Payment summary for this recurring payments profile.

AggregateAmount

cc:AmountType

Total amount collected thus far for scheduled payments.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

AggregateOptionalAmount

cc:AmountType

Total amount collected thus far for optional payments.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

FinalPaymentDueDate

xs:DateTime

Final scheduled payment due date before the profile expires.

(Optional) Information that is usually displayed in the account holder's statement, for example, <Your-Not-For-Profit> State, <Your-Not-For-Profit> Branch-Name, <Your-Website> dues or <Your-Website> list fee.

Character length and limitations: 23 alphanumeric characters, can include the special characters dash (-) and dot (.) only. Asterisks (*) are NOT permitted. If it includes a space character (), enclose the " Soft-Descriptor" value in double quotes.

Note: For US Website Payments Pro AMEX cards only and only for merchants passing dynamic soft descriptors, the dynamic soft descriptors for AMEX cards are only guaranteed once the transaction settles. This means that during the authorization time the card issuing bank might show their customer the registered business or legal name for the merchant versus the dynamic soft descriptor passed on a per API transaction.

(Optional) A unique phone number, email address or URL, which is displayed on the account holder's statement. PayPal recommends passing a toll-free phone number because, typically, this is the easiest way for a buyer to contact the seller in the case of an inquiry.
Character length and limitations: 13 characters including special characters, such as, space, !, ", #, $, %, &, ', (, ), +, -,*, /, :, ;, <, =, >, ?, @, comma and period.

If it includes the space character (), enclose the " Soft-Descriptor-City" value in double quotes.

Note: Underscore (_) is an illegal character for this field. If it is passed, then it will be removed leaving the remaining characters in the same order. For example, New_York changes to NewYork.

CreditCard

ebl:CreditCardDetailsType

If this is a recurring payments profile using direct payments, this field contains the credit card information for this profile.

Note: Only the last 4 digits of the credit card account number are returned. The CVV2 value is not returned.

SubscriberName

xs:string

Full name of the person receiving the product or service paid for by the recurring payment. If not present, the name in the buyer's PayPal account is used.

Character length and limitations: 32 double-byte characters.

SubscriberShipping Address

ebl:AddressType

The subscriber's shipping address associated with this profile, if applicable. If you do not specify it, the ship-to address from buyer's PayPal account is used.

Note: Shipping Address is optional, but if you include it, you are required to pass certain fields.

BillingStartDate

xs:dateTime

The date when billing for this profile begins.

Note: The profile may take up to 24 hours for activation.

Character length and limitations:

Date and time are in UTC/GMT format. For example, 2013-08-24T05:38:48Z.

ProfileReference

xs:string

The merchant's own unique reference or invoice number.

Character length and limitations: 127 single-byte alphanumeric characters.

addressStatus

ebl:addressStatusTypeCode

Status of street address on file with PayPal. Value is:

• none

• Confirmed

• Unconfirmed

Name

xs:string

Person's name associated with this address.

Character length and limitations: 32 double-byte characters

Street1

xs:string

First street address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

Second street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

Name of city.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

State or province.

It is required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal State codes.

Character length and limitations: 40 single-byte characters

PostalCode

xs:string

U.S. ZIP code or other country-specific postal code.

Character length and limitations: 20 single-byte characters

Country

ebl:CountryCode

Country code.

Character length and limitations: 2 single-byte characters

BillingPeriod

ebl:BillingPeriodType

Unit for billing during this subscription period. Value is:

• Day

• Week

• SemiMonth

• Month

• Year

For SemiMonth, billing is done on the 1st and 15th of each month.

Note: The combination of BillingPeriod and BillingFrequency cannot exceed one year.

BillingFrequency

xs:int

Number of billing periods that make up one billing cycle. The combination of billing frequency and billing period must be less than or equal to one year. For example, if the billing cycle is Month, the maximum value for billing frequency is 12. Similarly, if the billing cycle is Week, the maximum value for billing frequency is 52.

Note: If the billing period is SemiMonth, the billing frequency must be 1.

TotalBillingCycles

xs:int

Number of billing cycles for payment period (either the regular payment period or the trial period).

• For the trial period, the value must be greater than 0.

• For the regular payment period, if no value is specified or the value is 0, the regular payment period continues until the profile is canceled or deactivated.

• For the regular payment period, if the value is greater than 0, the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles.

Amount

cc:BasicAmountType

Billing amount for each billing cycle during this payment period. This amount does not include shipping and tax amounts.

Note: All amounts in the CreateRecurringPaymentsProfile request must have the same currency.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

ShippingAmount

cc:BasicAmountType

Shipping amount for each billing cycle during this payment period.

Note: All amounts in the request must have the same currency.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

TaxAmount

cc:BasicAmountType

Tax amount for each billing cycle during this payment period.

Note: All amounts in the request must have the same currency.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

NextBillingDate

xs:dateTime

The next scheduled billing date, in YYYY-MM-DD format.

NumberCycles Completed

xs:int

The number of billing cycles completed in the current active subscription period. A billing cycle is considered completed when payment is collected or after retry attempts to collect payment for the current billing cycle have failed.

NumberCycles Remaining

xs:int

The number of billing cycles remaining in the current active subscription period.

OutstandingBalance

cc:BasicAmountType

The current past due or outstanding balance for this profile.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

FailedPaymentCount

xs:int

The total number of failed billing cycles for this profile.

LastPaymentDate

xs:dateTime

The date of the last successful payment received for this profile, in YYYY-MM-DD format.

LastPaymentAmount

cc:BasicAmountType

The amount of the last successful payment received for this profile.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

CreditCardType

ebl:CreditCardType

Type of credit card. Is one of the following values:

• Visa
• MasterCard
• Discover
• Amex
• JCB
• Maestro — See note.

Note: If the credit card type is Maestro, you must set the currencyId to GBP. In addition, you must specify either StartMonth and StartYear or IssueNumber.

Character length and limitations: Up to 10 single-byte alphabetic characters

CreditCardNumber

xs:string

Credit card number. Only the last 4 digits of the credit card number are returned.

Character length and limitations: Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type.

ExpMonth

xs:int

Credit card expiration month.

Character length and limitations: 2 single-byte numeric characters, including leading zero

ExpYear

xs:int

Credit card expiration year.

Character length and limitations: 4 single-byte numeric characters

CardOwner

ebl:PayerInfoType

Details about the owner of the credit card.

Note: Payer information is only returned with Direct Credit Card (DCC) transactions. This info is not returned for PayPal payments.

StartMonth

xs:int

Month that Maestro card was issued.

Character length and limitations: 2-digit, zero-filled if necessary

StartYear

xs:int

Year that Maestro card was issued.

Character length and limitations: 4 digits

IssueNumber

xs:string

Issue number of Maestro card.

Character length and limitations: 2 numeric digits

Payer

ebl:EmailAddressType

Email address of buyer.

Character length and limitations: 127 single-byte characters

FirstName

ebl:PersonNameType

Buyer's first name.

Character length and limitations: 64 double-byte characters

LastName

ebl:PersonNameType

Buyer's last name.

Character length and limitations: 64 double-byte characters

Address

ebl:AddressType

Buyer's billing address information.

AddressOwner

ebl:AddressOwnerTypeCode

eBay company that maintains this address. Value is:

• eBay

• PayPal

addressStatus

ebl:addressStatusTypeCode

Status of street address on file with PayPal. Value is:

• none

• Confirmed

• Unconfirmed

Name

xs:string

Person's name associated with this address.

Character length and limitations: 32 double-byte characters

Street1

xs:string

First street address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

Second street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

Name of city.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

State or province.

It is required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal State codes.

Character length and limitations: 40 single-byte characters

PostalCode

xs:string

U.S. ZIP code or other country-specific postal code.

Character length and limitations: 20 single-byte characters

Country

ebl:CountryCode

Country code.

Character length and limitations: 2 single-byte characters

CountryName

xs:string

Expanded name of country.

Character length and limitations: 64 single-byte alphanumeric characters

Phone

xs:string

Phone number.

Character length and limitations: 20 single-byte characters