Subscriptions API

The account identifier for a PayPal account.

The street number.

The street name. Just Drury in Drury Lane.

The street type. For example, avenue, boulevard, road, or expressway.

The delivery service. Post office box, bag number, or post office name.

A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.

The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:

• The postal sorting code for Guernsey and many French territories, such as French Guiana.
• The fine-grained administrative levels in China.

A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:

• Brazil. Suburb, bairro, or neighborhood.
• India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

A city, town, or village. Smaller than admin_area_level_1.

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

A city, town, or village. Smaller than admin_area_level_1.

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

The amount for this transaction.

The item total for the transaction.

The fee details for the transaction.

The shipping amount for the transaction.

The tax amount for the transaction.

The net amount that the payee receives for this transaction in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee.

The label that overrides the business name in the PayPal account on the PayPal site.

The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.

The location from which the shipping address is derived.

The possible values are:

• GET_FROM_FILE. Get the customer-provided shipping address on the PayPal site.
• NO_SHIPPING. Redacts the shipping address from the PayPal site. Recommended for digital goods.
• SET_PROVIDED_ADDRESS. Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.

Configures the label name to Continue or Subscribe Now for subscription consent experience.

The possible values are:

• CONTINUE. After you redirect the customer to the PayPal subscription consent page, a Continue button appears. Use this option when you want to control the activation of the subscription and do not want PayPal to activate the subscription.
• SUBSCRIBE_NOW. After you redirect the customer to the PayPal subscription consent page, a Subscribe Now button appears. Use this option when you want PayPal to activate the subscription.

The customer and merchant payment preferences. Currently only PAYPAL payment method is supported.

The URL where the customer is redirected after the customer approves the payment.

The URL where the customer is redirected after the customer cancels the payment.

The backup card response information.

The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.

The frequency details for this billing cycle.

The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are allowed per plan.

The possible values are:

• REGULAR. A regular billing cycle.
• TRIAL. A trial billing cycle.

The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.

The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.

The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.

The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

The status of the captured payment.

The possible values are:

• COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.
• DECLINED. The funds could not be captured.
• PARTIALLY_REFUNDED. An amount less than this captured payment's amount was partially refunded to the payer.
• PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
• REFUNDED. An amount greater than or equal to this captured payment's amount was refunded to the payer.

The status of the captured payment.

The possible values are:

• COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.
• DECLINED. The funds could not be captured.
• PARTIALLY_REFUNDED. An amount less than this captured payment's amount was partially refunded to the payer.
• PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
• REFUNDED. An amount greater than or equal to this captured payment's amount was refunded to the payer.

The status of the captured payment.

The possible values are:

• COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.
• DECLINED. The funds could not be captured.
• PARTIALLY_REFUNDED. An amount less than this captured payment's amount was partially refunded to the payer.
• PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
• REFUNDED. An amount greater than or equal to this captured payment's amount was refunded to the payer.

The details of the captured payment status.

The reason why the captured payment status is PENDING or DENIED.

The possible values are:

• BUYER_COMPLAINT. The payer initiated a dispute for this captured payment with PayPal.
• CHARGEBACK. The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment.
• ECHECK. The payer paid by an eCheck that has not yet cleared.
• INTERNATIONAL_WITHDRAWAL. Visit your online account. In your **Account Overview**, accept and deny this payment.
• OTHER. No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal.
• PENDING_REVIEW. The captured payment is pending manual review.
• RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION. The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee.
• REFUNDED. The captured funds were refunded.
• TRANSACTION_APPROVED_AWAITING_FUNDING. The payer must send the funds for this captured payment. This code generally appears for manual EFTs.
• UNILATERAL. The payee does not have a PayPal account.
• VERIFICATION_REQUIRED. The payee's PayPal account is not verified.

The PayPal-generated ID for the card.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

The card expiration year and month, in Internet date format.

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID.

The last digits of the payment card.

The card brand or network. Typically used in the response.

The possible values are:

• VISA. Visa card.
• MASTERCARD. Mastecard card.
• DISCOVER. Discover card.
• AMEX. American Express card.
• SOLO. Solo debit card.
• JCB. Japan Credit Bureau card.
• STAR. Military Star card.
• DELTA. Delta Airlines card.
• SWITCH. Switch credit card.
• MAESTRO. Maestro credit card.
• CB_NATIONALE. Carte Bancaire (CB) credit card.
• CONFIGOGA. Configoga credit card.
• CONFIDIS. Confidis credit card.
• ELECTRON. Visa Electron credit card.
• CETELEM. Cetelem credit card.
• CHINA_UNION_PAY. China union pay credit card.

The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

A city, town, or village. Smaller than admin_area_level_1.

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

The card network or brand. Applies to credit, debit, gift, and payment cards.

The possible values are:

• VISA. Visa card.
• MASTERCARD. Mastecard card.
• DISCOVER. Discover card.
• AMEX. American Express card.
• SOLO. Solo debit card.
• JCB. Japan Credit Bureau card.
• STAR. Military Star card.
• DELTA. Delta Airlines card.
• SWITCH. Switch credit card.
• MAESTRO. Maestro credit card.
• CB_NATIONALE. Carte Bancaire (CB) credit card.
• CONFIGOGA. Configoga credit card.
• CONFIDIS. Confidis credit card.
• ELECTRON. Visa Electron credit card.
• CETELEM. Cetelem credit card.
• CHINA_UNION_PAY. China union pay credit card.

The last digits of the payment card.

The card brand or network. Typically used in the response.

The possible values are:

• VISA. Visa card.
• MASTERCARD. Mastecard card.
• DISCOVER. Discover card.
• AMEX. American Express card.
• SOLO. Solo debit card.
• JCB. Japan Credit Bureau card.
• STAR. Military Star card.
• DELTA. Delta Airlines card.
• SWITCH. Switch credit card.
• MAESTRO. Maestro credit card.
• CB_NATIONALE. Carte Bancaire (CB) credit card.
• CONFIGOGA. Configoga credit card.
• CONFIDIS. Confidis credit card.
• ELECTRON. Visa Electron credit card.
• CETELEM. Cetelem credit card.
• CHINA_UNION_PAY. China union pay credit card.

The payment card type.

The possible values are:

• CREDIT. A credit card.
• DEBIT. A debit card.
• PREPAID. A Prepaid card.
• UNKNOWN. Card type cannot be determined.

The last digits of the payment card.

The card brand or network. Typically used in the response.

The payment card type.

The card holder's name as it appears on the card.

The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

The three-character ISO-4217 currency code that identifies the currency.

The type of the billing cycle.

The possible values are:

• REGULAR. A regular billing cycle.
• TRIAL. A trial billing cycle.

The order in which to run this cycle among other billing cycles.

The number of billing cycles that have completed.

For a finite billing cycle, cycles_remaining is the number of remaining cycles. For an infinite billing cycle, cycles_remaining is set as 0.

The active pricing scheme version for the billing cycle.

The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

The internationalized email address.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

The internationalized email address.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

The human-readable, unique name of the error.

The message that describes the error.

The PayPal internal ID. Used for correlation purposes.

The information link, or URI, that shows detailed information about this error for the developer.

An array of additional details about the error.

An array of request-related HATEOAS links.

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

The value of the field that caused the error.

The location of the field that caused the error. Value is body, path, or query.

The unique, fine-grained application-level error code.

The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

The failed payment amount.

The date and time when the failed payment was made, in Internet date and time format.

The reason code for the payment failure.

The possible values are:

• PAYMENT_DENIED. PayPal declined the payment due to one or more customer issues.
• INTERNAL_SERVER_ERROR. An internal server error has occurred.
• PAYEE_ACCOUNT_RESTRICTED. The payee account is not in good standing and cannot receive payments.
• PAYER_ACCOUNT_RESTRICTED. The payer account is not in good standing and cannot make payments.
• PAYER_CANNOT_PAY. Payer cannot pay for this transaction.
• SENDING_LIMIT_EXCEEDED. The transaction exceeds the payer's sending limit.
• TRANSACTION_RECEIVING_LIMIT_EXCEEDED. The transaction exceeds the receiver's receiving limit.
• CURRENCY_MISMATCH. The transaction is declined due to a currency mismatch.

The time when the retry attempt for the failed payment occurs, in Internet date and time format.

The interval at which the subscription is charged or billed.

The possible values are:

• DAY. A daily billing cycle.
• WEEK. A weekly billing cycle.
• MONTH. A monthly billing cycle.
• YEAR. A yearly billing cycle.

The number of intervals after which a subscriber is billed. For example, if the interval_unit is DAY with an interval_count of 2, the subscription is billed once every two days. The following table lists the maximum allowed values for the interval_count for each interval_unit:

The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code.

The status of the captured payment.

The last payment amount.

The date and time when the last payment was made, in Internet date and time format.

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The unique ID for a customer in merchant's or partner's system of records.

The three-character ISO-4217 currency code that identifies the currency.

The value, which might be:

• An integer for currencies like JPY that are not typically fractional.
• A decimal fraction for currencies like TND that are subdivided into thousandths.

The prefix, or title, to the party's name.

When the party is a person, the party's given, or first, name.

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

The suffix for the party's name.

DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

When the party is a person, the party's full name.

The operation.

The possible values are:

• add. Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
  The value parameter defines the value to add. For more information, see 4.1. add.
• remove. Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
• replace. Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.
• move. Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.
• copy. Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.
• test. Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

  Type	Considered equal if both values
  strings	Contain the same number of Unicode characters and their code points are byte-by-byte equal.
  numbers	Are numerically equal.
  arrays	Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
  objects	Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
  literals (false, true, and null)	Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.

  For more information, see 4.6. test.

The JSON Pointer to the target document location at which to complete the operation.

The value to apply. The remove operation does not require a value.

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

An array of JSON patch objects to apply partial updates to resources.

The email address of merchant.

The encrypted PayPal account ID of the merchant.

The merchant-preferred payment methods.

The possible values are:

• UNRESTRICTED. Accepts any type of payment from the customer.
• IMMEDIATE_PAYMENT_REQUIRED. Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status.

The name of the payer. Supports only the given_name and surname properties.

The email address of the payer.

The PayPal-assigned ID for the payer.

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.

The name of the payer. Supports only the given_name and surname properties.

The email address of the payer.

The PayPal-assigned ID for the payer.

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.

The birth date of the payer in YYYY-MM-DD format.

The tax information of the payer. Required only for Brazilian payer's. Both tax_id and tax_id_type are required.

The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.

The name of the payer. Supports only the given_name and surname properties.

The email address of the payer.

The PayPal-assigned ID for the payer.

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

A city, town, or village. Smaller than admin_area_level_1.

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

When the party is a person, the party's given, or first, name.

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

The customer-selected payment method on the merchant site.

The merchant-preferred payment methods.

The possible values are:

• UNRESTRICTED. Accepts any type of payment from the customer.
• IMMEDIATE_PAYMENT_REQUIRED. Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status.

NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.

The possible values are:

• TEL. The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone.
• WEB. The API caller (merchant/partner) accepts Debit transactions from a consumer on their website.
• CCD. Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers).
• PPD. Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums).

Indicates whether to automatically bill the outstanding amount in the next billing cycle.

The initial set-up fee for the service.

The action to take on the subscription if the initial payment for the setup fails.

The possible values are:

• CONTINUE. Continues the subscription if the initial payment for the setup fails.
• CANCEL. Cancels the subscription if the initial payment for the setup fails.

The maximum number of payment failures before a subscription is suspended. For example, if payment_failure_threshold is 2, the subscription automatically updates to the SUSPEND state if two consecutive payments fail.

Indicates whether to automatically bill the outstanding amount in the next billing cycle.

The initial set-up fee for the service.

The action to take on the subscription if the initial payment for the setup fails.

The possible values are:

• CONTINUE. Continues the subscription if the initial payment for the setup fails.
• CANCEL. Cancels the subscription if the initial payment for the setup fails.

The maximum number of payment failures before a subscription is suspended. For example, if payment_failure_threshold is 2, the subscription automatically updates to the SUSPEND state if two consecutive payments fail.

The payment card to use to fund a payment. Can be a credit or debit card.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

The card expiration year and month, in Internet date format.

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID.

The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.

The payment card used to fund the payment. Card can be a credit or debit card.

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.

The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

The extension number.

The phone type.

The phone type.

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

The unique PayPal-generated ID for the plan.

The ID for the product.

The plan name.

The plan status.

The possible values are:

• CREATED. The plan was created. You cannot create subscriptions for a plan in this state.
• INACTIVE. The plan is inactive.
• ACTIVE. The plan is active. You can only create subscriptions for a plan in this state.

The detailed description of the plan.

An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

The payment preferences for a subscription.

The tax details.

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

The date and time when the plan was created, in Internet date and time format.

The date and time when the plan was last updated, in Internet date and time format.

An array of request-related HATEOAS links.

The ID for the product.

The plan name.

The detailed description of the plan.

An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

The payment preferences for a subscription.

The tax details.

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

An array of plans.

The total number of items.

The total number of pages.

An array of request-related HATEOAS links.

An array of billing cycles for trial billing and regular billing. The subscription billing cycle definition has to adhere to the plan billing cycle definition.

The payment preferences to override at subscription level.

The tax details.

The ID of the product.

The plan name.

The initial state of the plan. Allowed input values are CREATED and ACTIVE.

The possible values are:

• CREATED. The plan was created. You cannot create subscriptions for a plan in this state.
• INACTIVE. The plan is inactive.
• ACTIVE. The plan is active. You can only create subscriptions for a plan in this state.

The detailed description of the plan.

An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

The payment preferences for a subscription.

The tax details.

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

The version of the pricing scheme.

The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected.

The pricing model for tiered plan. The tiers parameter is required.

The possible values are:

• VOLUME. A volume pricing model.
• TIERED. A tiered pricing model.

An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified.

The date and time when this pricing scheme was created, in Internet date and time format.

The date and time when this pricing scheme was last updated, in Internet date and time format.

The starting quantity for the tier.

The ending quantity for the tier. Optional for the last tier.

The pricing amount for the tier.

The name of the person to whom to ship the items. Supports only the full_name property.

The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

A city, town, or village. Smaller than admin_area_level_1.

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

When the party is a person, the party's full name.

The method by which the payer wants to get their items.

The possible values are:

• SHIPPING. The payer intends to receive the items at a specified address.
• PICKUP. The payer intends to pick up the items at a specified address. For example, a store address.

The name of the payer. Supports only the given_name and surname properties.

The email address of the payer.

The PayPal-assigned ID for the payer.

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.

The shipping details.

The payment source used to fund the payment.

The name of the payer. Supports only the given_name and surname properties.

The email address of the payer.

The PayPal-assigned ID for the payer.

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.

The shipping details.

The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.

The status of the subscription.

The reason or notes for the status of the subscription.

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The PayPal-generated ID for the subscription.

The ID of the plan.

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The quantity of the product in the subscription.

The currency and amount for a financial transaction, such as a balance or payment due.

The subscriber response information.

The billing details for the subscription. If the subscription was or is active, these fields are populated.

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The custom id for the subscription. Can be invoice id.

Indicates whether the subscription has overridden any plan attributes.

Inline plan details.

An array of request-related HATEOAS links.

The reason for activation of a subscription. Required to reactivate the subscription.

The total pending bill amount, to be paid by the subscriber.

The trial and regular billing executions.

The details for the last payment of the subscription.

The next date and time for billing this subscription, in Internet date and time format.

The date and time when the final billing cycle occurs, in Internet date and time format.

The number of consecutive payment failures. Resets to 0 after a successful payment. If this reaches the payment_failure_threshold value, the subscription updates to the SUSPENDED state.

The details for the last failed payment of the subscription.

The reason for the cancellation of a subscription.

The reason or note for the subscription charge.

The type of capture.

The possible values are:

• OUTSTANDING_BALANCE. The outstanding balance that the subscriber must clear.

The amount of the outstanding balance. This value cannot be greater than the current outstanding balance amount.

An array of subscriptions.

The total number of items.

The total number of pages.

An array of request-related HATEOAS links.

The ID of the plan.

The date and time when the subscription started, in Internet date and time format.

The quantity of the product in the subscription.

The shipping charges.

The subscriber request information .

DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete.

The application context, which customizes the payer experience during the subscription approval process with PayPal.

The custom id for the subscription. Can be invoice id.

An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object.

The unique PayPal-generated ID for the plan.

The quantity of the product or service in the subscription.

The date and time when this change is effective, in Internet date and time format. Defaults to the current time.

The shipping charges.

The shipping address of the subscriber.

The application context, which customizes the payer experience during the subscription approval process with PayPal.

An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise.

The unique PayPal-generated ID for the plan.

The quantity of the product or service in the subscription.

The date and time when this change is effective, in Internet date and time format. Defaults to the current time.

The shipping charges.

The shipping address of the subscriber.

An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise.

The label that overrides the business name in the PayPal account on the PayPal site.

The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.

The location from which the shipping address is derived.

The possible values are:

• GET_FROM_FILE. Get the customer-provided shipping address on the PayPal site.
• NO_SHIPPING. Redacts the shipping address from the PayPal site. Recommended for digital goods.
• SET_PROVIDED_ADDRESS. Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.

The customer and merchant payment preferences. Currently only PAYPAL payment method is supported.

The URL where the customer is redirected after the customer approves the payment.

The URL where the customer is redirected after the customer cancels the payment.

The unique PayPal-generated ID for the plan.