On this page
No Headings
Last updated: June 18, 2026
Important: NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, we recommend our latest solutions.
Shows information about a recurring payments profile.
| Field | Description |
|---|---|
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 |
| Field | Description |
|---|---|
ProfileID | xs:stringRecurring payments profile ID returned in the CreateRecurringPaymentsProfile response. |
ProfileStatus | cc:RecurringPaymentsProfileStatusTypeStatus of the recurring payment profile. Value is:
|
Description | xs:stringDescription of the recurring payment. Character length and limitations: 127 single-byte alphanumeric characters |
AutoBillOutstandingAmount | ebl:AutoBillTypeIndicates 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:
|
MaxFailedPayments | xs:intNumber of scheduled payments that can fail before the profile is automatically suspended. Character length and limitations: Number string representing an integer |
RecurringPayments ProfileDetails | ebl:RecurringPaymentsProfileDetailsTypeBuyer information for this recurring payments profile. |
CurrentRecurring PaymentsPeriod | ebl:BillingPeriodDetailsTypeDetails of the current subscription period. This field is not returned if the profile is canceled or expired. |
RecurringPayments Summary | ebl:RecurringPaymentsSummaryDetailsTypePayment summary for this recurring payments profile. |
AggregateAmount | cc:AmountTypeTotal 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:AmountTypeTotal 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:DateTimeFinal scheduled payment due date before the profile expires. |
SoftDescriptor | (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. |
SoftDescriptorCity | (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:CreditCardDetailsTypeIf 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. |
| Field | Description |
|---|---|
SubscriberName | xs:stringFull 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:AddressTypeThe 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:dateTimeThe date when billing for this profile begins. Note: The profile may take up to 24 hours for activation. 2013-08-24T05:38:48Z. |
ProfileReference | xs:stringThe merchant's own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters. |
| Field | Description |
|---|---|
addressStatus | ebl:addressStatusTypeCodeStatus of street address on file with PayPal. Value is:
|
Name | xs:stringPerson's name associated with this address. Character length and limitations: 32 double-byte characters |
Street1 | xs:stringFirst street address. Character length and limitations: 100 single-byte characters |
Street2 | xs:stringSecond street address. Character length and limitations: 100 single-byte characters |
CityName | xs:stringName of city. Character length and limitations: 40 single-byte characters |
StateOrProvince | xs:stringState or province. 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:stringU.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
Country | ebl:CountryCodeCountry code. Character length and limitations: 2 single-byte characters |
| Field | Description |
|---|---|
BillingPeriod | ebl:BillingPeriodTypeUnit for billing during this subscription period. Value is:
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:intNumber 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:intNumber of billing cycles for payment period (either the regular payment period or the trial period).
|
Amount | cc:BasicAmountTypeBilling 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. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
ShippingAmount | cc:BasicAmountTypeShipping amount for each billing cycle during this payment period. Note: All amounts in the request must have the same currency. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
TaxAmount | cc:BasicAmountTypeTax amount for each billing cycle during this payment period. Note: All amounts in the request must have the same currency. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
| Field | Description |
|---|---|
NextBillingDate | xs:dateTimeThe next scheduled billing date, in YYYY-MM-DD format. |
NumberCycles Completed | xs:intThe 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:intThe number of billing cycles remaining in the current active subscription period. |
OutstandingBalance | cc:BasicAmountTypeThe 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:intThe total number of failed billing cycles for this profile. |
LastPaymentDate | xs:dateTimeThe date of the last successful payment received for this profile, in YYYY-MM-DD format. |
LastPaymentAmount | cc:BasicAmountTypeThe 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. |
| Field | Description |
|---|---|
CreditCardType | ebl:CreditCardTypeType of credit card. Is one of the following values:
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. |
CreditCardNumber | xs:stringCredit 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:intCredit card expiration month. Character length and limitations: 2 single-byte numeric characters, including leading zero |
ExpYear | xs:intCredit card expiration year. Character length and limitations: 4 single-byte numeric characters |
CardOwner | ebl:PayerInfoTypeDetails 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:intMonth that Maestro card was issued. Character length and limitations: 2-digit, zero-filled if necessary |
StartYear | xs:intYear that Maestro card was issued. Character length and limitations: 4 digits |
IssueNumber | xs:stringIssue number of Maestro card. Character length and limitations: 2 numeric digits |
Information about the card owner.
Note: Payer information is only returned with Direct Credit Card (DCC) transactions. This info is not returned for PayPal payments.
| Field | Description |
|---|---|
Payer | ebl:EmailAddressTypeEmail address of buyer. Character length and limitations: 127 single-byte characters |
FirstName | ebl:PersonNameTypeBuyer's first name. Character length and limitations: 64 double-byte characters |
LastName | ebl:PersonNameTypeBuyer's last name. Character length and limitations: 64 double-byte characters |
Address | ebl:AddressTypeBuyer's billing address information. |
| Field | Description |
|---|---|
AddressOwner | ebl:AddressOwnerTypeCodeeBay company that maintains this address. Value is:
|
addressStatus | ebl:addressStatusTypeCodeStatus of street address on file with PayPal. Value is:
|
Name | xs:stringPerson's name associated with this address. Character length and limitations: 32 double-byte characters |
Street1 | xs:stringFirst street address. Character length and limitations: 100 single-byte characters |
Street2 | xs:stringSecond street address. Character length and limitations: 100 single-byte characters |
CityName | xs:stringName of city. Character length and limitations: 40 single-byte characters |
StateOrProvince | xs:stringState or province. 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:stringU.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
Country | ebl:CountryCodeCountry code. Character length and limitations: 2 single-byte characters |
CountryName | xs:stringExpanded name of country. Character length and limitations: 64 single-byte alphanumeric characters |
Phone | xs:stringPhone number. Character length and limitations: 20 single-byte characters |