Application Context

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

Schema Information

Type:object

Properties

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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

locale

Type: string

Format: ppaas_common_language_v3

Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$

Min length: 2

Max length: 10

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.

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 24

Default: "GET_FROM_FILE"

The location from which the shipping address is derived.

user_action

Type: string

Enum: "CONTINUE", "SUBSCRIBE_NOW"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 24

Default: "SUBSCRIBE_NOW"

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

payment_method

Type: object

The customer and merchant payment preferences.

payee_preferred

Type: string

Enum: "UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "UNRESTRICTED"

The merchant-preferred payment methods.

return_urlrequired

Type: string

Format: uri

Min length: 10

Max length: 4000

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

cancel_urlrequired

Type: string

Format: uri

Min length: 10

Max length: 4000

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

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

Schema Information

Type:object

Properties

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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

locale

Type: string

Format: ppaas_common_language_v3

Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$

Min length: 2

Max length: 10

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 24

Default: "GET_FROM_FILE"

The location from which the shipping address is derived.

user_action

Type: string

Enum: "CONTINUE", "SUBSCRIBE_NOW"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 24

Default: "SUBSCRIBE_NOW"

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

payment_method

Type: object

The customer and merchant payment preferences.

payee_preferred

Type: string

Enum: "UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "UNRESTRICTED"

The merchant-preferred payment methods.

return_urlrequired

Type: string

Format: uri

Min length: 10

Max length: 4000

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

cancel_urlrequired

Type: string

Format: uri

Min length: 10

Max length: 4000

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

Application Context

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Application Context

Schema Information

Properties