On this page
No Headings
Last updated: June 12, 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 |
|---|---|
METHOD | (Required) Must be GetRecurringPaymentsProfileDetails. |
PROFILEID | (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 | Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. |
STATUS | Status of the recurring payment profile. Value is:
|
DESC | Description of the recurring payment. Character length and limitations: 127 single-byte alphanumeric characters |
AUTOBILLOUTAMT | 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:
|
MAXFAILEDPAYMENTS | Number of scheduled payments that can fail before the profile is automatically suspended. Character length and limitations: Number string representing an integer |
AGGREGATEAMOUNT | 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 | 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 | Final 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. |
| Field | Description |
|---|---|
SUBSCRIBERNAME | 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. |
PROFILESTARTDATE | The date when billing for this profile begins. Must be a valid date, in UTC/GMT format; for example, 2012-08-24T05:38:48Z. Note: The profile may take up to 24 hours for activation. |
PROFILEREFERENCE | The merchant's own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters. |
| Field | Description |
|---|---|
ADDRESSSTATUS | Status of street address on file with PayPal. Value is:
|
SHIPTONAME | Person's name associated with this address. Character length and limitations: 32 double-byte characters |
SHIPTOSTREET | First street address. Character length and limitations: 100 single-byte characters |
SHIPTOSTREET2 | Second street address. Character length and limitations: 100 single-byte characters |
SHIPTOCITY | Name of city. Character length and limitations: 40 single-byte characters |
SHIPTOSTATE | State 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 |
SHIPTOZIP | U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
SHIPTOCOUNTRYCODE | Country code. Character length and limitations: 2 single-byte characters |
| Field | Description |
|---|---|
BILLINGPERIOD | Unit 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. |
REGULARBILLINGPERIOD | Unit for billing during this regular subscription period. Value is:
SemiMonth, billing is done on the 1st and 15th of each month. Note: The combination of RegularBillingPeriod and RegularBillingFrequency cannot exceed one year. |
BILLINGFREQUENCY | 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. |
REGULARBILLINGFREQUENCY | Number of billing periods that make up one regular 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 | Number of billing cycles for payment period (either the regular payment period or the trial period).
|
REGULARTOTALBILLINGCYCLES | Number of billing cycles for the regular payment period.
|
AMT | 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. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
REGULARAMT | Billing amount for each billing cycle during this regular 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.This field is available since version 53.0. |
SHIPPINGAMT | Shipping 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. |
REGULARSHIPPINGAMT | Shipping amount for each billing cycle during this regular 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.This field is available since version 53.0. |
TAXAMT | Tax 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. |
REGULARTAXAMT | Tax amount for each billing cycle during this regular 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.This field is available since version 53.0. |
CURRENCYCODE | (Required) Currency code (default is USD). Character length and limitations: 3 single-byte characters |
REGULARCURRENCYCODE | (Required) Currency code (default is USD). This field is available since version 53.0. |
| Field | Description |
|---|---|
NEXTBILLINGDATE | The next scheduled billing date, in YYYY-MM-DD format. |
NUMCYLESCOMPLETED | 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. |
NUMCYCLESREMAINING | The number of billing cycles remaining in the current active subscription period. |
OUTSTANDINGBALANCE | 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 | The total number of failed billing cycles for this profile. |
LASTPAYMENTDATE | The date of the last successful payment received for this profile, in YYYY-MM-DD format. |
LASTPAYMENTAMT | 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. |
| Field | Description |
|---|---|
CREDITCARDTYPE | Type 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. |
ACCT | 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. |
EXPDATE | Credit card expiration date. This field is required if you are using recurring payments with direct payments. Character length and limitations: 6 single-byte alphanumeric characters, including leading zero, in the format MMYYYY |
STARTDATE | Month and year that Maestro card was issued. Character length and limitations: Must be 6 digits, including leading zero, in the format MMYYYY |
ISSUENUMBER | Issue number of Maestro card. Character length and limitations: 2 numeric digits |
Note: Card owner or payer information is only returned with Direct Credit Card (DCC) transactions. This info is not returned for PayPal payments.
| Field | Description |
|---|---|
EMAIL | Email address of buyer. Character length and limitations: 127 single-byte characters |
FIRSTNAME | Buyer's first name. Character length and limitations: 64 double-byte characters |
LASTNAME | Buyer's last name. Character length and limitations: 64 double-byte characters |
| Field | Description |
|---|---|
ADDRESSOWNER | eBay company that maintains this address. Value is:
|
ADDRESSSTATUS | Status of street address on file with PayPal. Value is:
|
SHIPTOSECONDARYNAME | Person's name associated with this secondary address. Character length and limitations: 32 double-byte characters |
SHIPTONAME | Person's name associated with this address. Character length and limitations: 32 double-byte characters |
SHIPTOSTREET | First street address. Character length and limitations: 100 single-byte characters |
SHIPTOSECONDARYADDRESSLINE1 | First line of street address for secondary address. Character length and limitations: 100 single-byte characters |
SHIPTOSTREET2 | Second street address. Character length and limitations: 100 single-byte characters |
SHIPTOSECONDARYADDRESSLINE2 | Second line of street address for secondary address. Character length and limitations: 100 single-byte characters |
SHIPTOCITY | Name of city. Character length and limitations: 40 single-byte characters |
SHIPTOSECONDARYCITY | Name of city for secondary address. Character length and limitations: 40 single-byte characters |
SHIPTOSTATE | State 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 |
SHIPTOSECONDARYSTATE | State or province for secondary address. Required for U.S. addresses only. Character length and limitations: 40 single-byte characters |
SHIPTOZIP | U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
SHIPTOSECONDARYZIP | U.S. ZIP code or other country-specific postal code for secondary address. Character length and limitations: 20 single-byte characters |
SHIPTOCOUNTRYCODE | Country code. Character length and limitations: 2 single-byte characters |
SHIPTOSECONDARYCOUNTRYCODE | Country code for secondary address.Character length and limitations: 2 single-byte characters |
SHIPTOPHONENUM | Phone number. Character length and limitations: 20 single-byte characters |
SHIPTOSECONDARYPHONENUM | Phone number for secondary address.Character length and limitations: 20 single-byte characters |