GetRecurringPaymentsProfileDetails API Operation (SOAP)
Shows information about a recurring payments profile.
GetRecurringPaymentsProfileDetails Request Message
GetRecurringPaymentsProfileDetails Request Fields
Field | Description |
---|---|
|
(Required) Recurring payments profile ID returned in the Character length and limitations: 14 single-byte alphanumeric characters |
GetRecurringPaymentsProfileDetails Response Message
GetRecurringPaymentsProfileDetails Response Fields
Field | Description |
---|---|
|
Recurring payments profile ID returned in the |
|
Status of the recurring payment profile. Value is:
|
|
Description of the recurring payment. Character length and limitations: 127 single-byte alphanumeric characters |
|
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:
|
|
Number of scheduled payments that can fail before the profile is automatically suspended. Character length and limitations: Number string representing an integer |
|
Buyer information for this recurring payments profile. |
|
Details of the current subscription period. This field is not returned if the profile is canceled or expired. |
|
Payment summary for this recurring payments profile. |
|
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 ( |
|
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 ( |
|
Final scheduled payment due date before the profile expires. |
SoftDescriptor |
(Optional) Information that is usually displayed in the account holder's statement, for example, Character length and limitations: 23 alphanumeric characters, can include the special characters dash (
|
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. If it includes the space character (
|
|
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. |
RecurringPaymentsProfileDetailsType 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 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. |
|
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, |
|
The merchant's own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters. |
AddressType (Shipping) 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.
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 |
|
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 |
BillingPeriodDetailsType Fields
Field | Description |
---|---|
|
Unit for billing during this subscription period. Value is:
For Note: The combination of |
|
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 cycles for payment period (either the regular payment period or the trial period).
|
|
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: 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 ( |
|
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 ( |
|
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 ( |
RecurringPaymentsSummaryDetailsType 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: 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 ( |
|
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: 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 ( |
CreditCardDetailsType Fields
PayerInfoType Fields
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 |
---|---|
|
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 |
|
Buyer's billing address information. |
AddressType 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 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.
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 |
|
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 |
|
Expanded name of country. Character length and limitations: 64 single-byte alphanumeric characters |
|
Phone number. Character length and limitations: 20 single-byte characters |