# VaultPayPalBillingAgreementInput

Input · GraphQL API

Top-level input fields for importing and vaulting a PayPal Billing Agreement.

## Fields

- `clientMutationId` (`String`): An identifier used to reconcile requests and responses. 255 characters maximum.
- `billingAgreementId` (`String!`) — required: ID of a PayPal Billing Agreement, that was not created through Braintree, to import and vault.
- `customerId` (`ID`): Optional ID of the customer to associate the resulting payment method with.
- `merchantAccountId` (`ID`): Optional ID of the merchant account associated with the linked PayPal account to be used to retrieve billing agreement details from PayPal. Only used for merchants with the PayPal multi-account feature enabled in Braintree.
- `indirectPayee` (`PayPalAccountInput`): The merchant (payee) PayPal account associated with the PayPal Billing Agreement being vaulted. Only used when the specified merchant account is specially configured to handle indirect PayPal accounts.

## Used by

- [vaultPayPalBillingAgreement](/braintree/graphql/reference/mutations/vault-pay-pal-billing-agreement) — Mutation; input

## GraphQL definition

```graphql
input VaultPayPalBillingAgreementInput {
  clientMutationId: String
  billingAgreementId: String!
  customerId: ID
  merchantAccountId: ID
  indirectPayee: PayPalAccountInput
}
```

---

[View the complete GraphQL schema on GitHub](https://raw.githubusercontent.com/braintree/graphql-api/refs/heads/master/schema.graphql)