Subscriber Request

January 21, 2026 ยท View on GitHub

The subscriber request information .

Structure

SubscriberRequest

Fields

NameTypeTagsDescriptionGetterSetter
EmailAddressStringOptionalThe 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.

Constraints: Minimum Length: 3, Maximum Length: 254, Pattern: (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
String getEmailAddress()setEmailAddress(String emailAddress)
PayerIdStringOptionalThe account identifier for a PayPal account.

Constraints: Minimum Length: 13, Maximum Length: 13, Pattern: ^[2-9A-HJ-NP-Z]{13}$
String getPayerId()setPayerId(String payerId)
NameNameOptionalThe name of the party.Name getName()setName(Name name)
ShippingAddressShippingDetailsOptionalThe shipping details.ShippingDetails getShippingAddress()setShippingAddress(ShippingDetails shippingAddress)
PaymentSourceSubscriptionPaymentSourceOptionalThe 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.SubscriptionPaymentSource getPaymentSource()setPaymentSource(SubscriptionPaymentSource paymentSource)
PhonePhoneWithTypeOptionalThe phone information.PhoneWithType getPhone()setPhone(PhoneWithType phone)

Example (as JSON)

{
  "email_address": "email_address0",
  "payer_id": "payer_id0",
  "name": {
    "given_name": "given_name2",
    "surname": "surname8"
  },
  "shipping_address": {
    "name": {
      "full_name": "full_name6"
    },
    "email_address": "email_address8",
    "phone_number": {
      "country_code": "country_code2",
      "national_number": "national_number6"
    },
    "type": "PICKUP_IN_STORE",
    "options": [
      {
        "id": "id2",
        "label": "label2",
        "type": "SHIPPING",
        "amount": {
          "currency_code": "currency_code6",
          "value": "value0"
        },
        "selected": false
      }
    ]
  },
  "payment_source": {
    "card": {
      "name": "name6",
      "number": "number6",
      "expiry": "expiry4",
      "security_code": "security_code8",
      "type": "UNKNOWN"
    }
  }
}