Top-level input field for creating a PayPal Billing Agreement Token.
cancelURL!RequiredURL for redirect back to merchant app on the client indicating unsuccessful approval.
returnURL!RequiredURL for redirect back to merchant app on the client indicating successful approval.
appPayContext information for enabling App Switch to the PayPal app during checkout.
emailEmailEmail of the payer (if known). This will prepopulate the input field in the PayPal approval page.
merchantIDBraintree merchant account ID associated with the PayPal account to be used for the Billing Agreement creation.
paypalPayDefines the experience profile used to render the billing agreement approval flow.
paypalPayProduct attributes input for PayPal billing agreement.
paypalIDPayPal Risk correlation ID (also known as the Client Metadata ID).
recurringPayBilling plan for recurring payments.
shippingAddressMerchant-provided shipping address. Fields addressLine1, adminArea2, and countryCode are required for Billing Agreements.
input CreatePayPalBillingAgreementInput {
clientMutationId: String
merchantAccountId: ID
returnUrl: URL!
cancelUrl: URL!
description: String
email: EmailAddress
offerPayPalCredit: Boolean
recurringBillingPlan: PayPalRecurringBillingPlanInput
paypalRiskCorrelationId: ID
paypalExperienceProfile: PayPalBillingAgreementExperienceProfileInput
shippingAddress: AddressInput
paypalProductAttributes: PayPalProductAttributesInput
customerSessionId: String
appSwitchContext: PayPalAppSwitchContextInput
}