forked from LiveCarta/PayPal-PHP-Server-SDK
1fc2cf1e07
* Automated commit message * Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
68 lines
2.1 KiB
Markdown
68 lines
2.1 KiB
Markdown
|
|
# Subscriber Request
|
|
|
|
The subscriber request information .
|
|
|
|
## Structure
|
|
|
|
`SubscriberRequest`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void |
|
|
| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void |
|
|
| `shippingAddress` | [`?ShippingDetails`](../../doc/models/shipping-details.md) | Optional | The shipping details. | getShippingAddress(): ?ShippingDetails | setShippingAddress(?ShippingDetails shippingAddress): void |
|
|
| `paymentSource` | [`?SubscriptionPaymentSource`](../../doc/models/subscription-payment-source.md) | Optional | 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. | getPaymentSource(): ?SubscriptionPaymentSource | setPaymentSource(?SubscriptionPaymentSource paymentSource): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"name": {
|
|
"given_name": "given_name2",
|
|
"surname": "surname8"
|
|
},
|
|
"phone": {
|
|
"phone_type": "OTHER",
|
|
"phone_number": {
|
|
"national_number": "national_number6"
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|