GetRecurringPaymentsProfileDetails API Operation (NVP)
APILegacyLast updated: October 12th 2021, @ 6:58:00 pm
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.
GetRecurringPaymentsProfileDetails Request Message
GetRecurringPaymentsProfileDetails Request Fields
Field | Description |
---|---|
| (Required) Must be |
| (Required) Recurring payments profile ID returned in the Character length and limitations: 14 single-byte alphanumeric characters |
GetRecurringPaymentsProfileDetails Response Message
GetRecurringPaymentsProfileDetails Response Fields
Recurring Payments Profile Details Fields
Field | Description |
---|---|
| 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. |
| The date when billing for this profile begins. Must be a valid date, in UTC/GMT format; for example, Note: The profile may take up to 24 hours for activation. |
| The merchant’s own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters. |
Ship To AddressType Fields
Field | Description |
---|---|
| Status of street address on file with PayPal. Value is:
|
| Person’s name associated with this address. Character length and limitations: 32 double-byte characters |
| First street address. Character length and limitations: 100 single-byte characters |
| Second street address. Character length and limitations: 100 single-byte characters |
| Name of city. Character length and limitations: 40 single-byte characters |
| State or province. Character length and limitations: 40 single-byte characters |
| U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
| Country code. Character length and limitations: 2 single-byte characters |
Billing Period Details Fields
Field | Description |
---|---|
| Unit for billing during this subscription period. Value is:
For Note: The combination of |
| Unit for billing during this regular subscription period. Value is:
For Note: The combination of This field is available since version 53.0. |
| 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 Note: If the billing period is |
| 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 Note: If the billing period is This field is available since version 53.0. |
| Number of billing cycles for payment period (either the regular payment period or the trial period).
|
| Number of billing cycles for the regular payment period.
This field is available since version 53.0. |
| Billing amount for each billing cycle during this payment period. This amount does not include shipping and tax amounts. Note: All amounts in the Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| 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 Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` This field is available since version 53.0. |
| 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: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| Shipping amount for each billing cycle during this regular payment period. Note: All amounts in the request must have the same currency. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` This field is available since version 53.0. |
| 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: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| Tax amount for each billing cycle during this regular payment period. Note: All amounts in the request must have the same currency. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` This field is available since version 53.0. |
| (Required) Currency code (default is USD). Character length and limitations: 3 single-byte characters |
| (Required) Currency code (default is USD). This field is available since version 53.0. |
Recurring Payments Summary Details Fields
Field | Description |
---|---|
| The next scheduled billing date, in YYYY-MM-DD format. |
| 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. |
| The number of billing cycles remaining in the current active subscription period. |
| The current past due or outstanding balance for this profile. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| The total number of failed billing cycles for this profile. |
| The date of the last successful payment received for this profile, in YYYY-MM-DD format. |
| The amount of the last successful payment received for this profile. Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
Credit Card Details Fields
PayerInfoType Fields
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 address of buyer. Character length and limitations: 127 single-byte characters |
| Buyer’s first name. Character length and limitations: 64 double-byte characters |
| Buyer’s last name. Character length and limitations: 64 double-byte characters |
Address Fields
Field | Description |
---|---|
| eBay company that maintains this address. Value is:
|
| Status of street address on file with PayPal. Value is:
|
| Person’s name associated with this secondary address. Character length and limitations: 32 double-byte characters |
| Person’s name associated with this address. Character length and limitations: 32 double-byte characters |
| First street address. Character length and limitations: 100 single-byte characters |
| First line of street address for secondary address. Character length and limitations: 100 single-byte characters |
| Second street address. Character length and limitations: 100 single-byte characters |
| Second line of street address for secondary address. Character length and limitations: 100 single-byte characters |
| Name of city. Character length and limitations: 40 single-byte characters |
| Name of city for secondary address. Character length and limitations: 40 single-byte characters |
| State or province. Character length and limitations: 40 single-byte characters |
| State or province for secondary address. Required for U.S. addresses only. Character length and limitations: 40 single-byte characters |
| U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
| U.S. ZIP code or other country-specific postal code for secondary address. Character length and limitations: 20 single-byte characters |
| Country code. Character length and limitations: 2 single-byte characters |
| Country code for secondary address. Character length and limitations: 2 single-byte characters |
| Phone number. Character length and limitations: 20 single-byte characters |
| Phone number for secondary address. Character length and limitations: 20 single-byte characters |