Subscriber
January 21, 2026 ยท View on GitHub
The subscriber response information.
Structure
Subscriber
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
EmailAddress | String | Optional | 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. 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) |
PayerId | String | Optional | The 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) |
Name | Name | Optional | The name of the party. | Name getName() | setName(Name name) |
ShippingAddress | ShippingDetails | Optional | The shipping details. | ShippingDetails getShippingAddress() | setShippingAddress(ShippingDetails shippingAddress) |
PaymentSource | SubscriptionPaymentSourceResponse | Optional | The payment source used to fund the payment. | SubscriptionPaymentSourceResponse getPaymentSource() | setPaymentSource(SubscriptionPaymentSourceResponse paymentSource) |
Example (as JSON)
{
"email_address": "email_address2",
"payer_id": "payer_id2",
"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",
"billing_address": {
"address_line_1": "address_line_12",
"address_line_2": "address_line_28",
"admin_area_2": "admin_area_28",
"admin_area_1": "admin_area_14",
"postal_code": "postal_code0",
"country_code": "country_code8"
},
"expiry": "expiry4",
"currency_code": "currency_code2"
}
}
}