customerPaymentMethodPaypalBillingAgreementCreate - admin-graphql - MUTATION

Version: 2024-10

Description:

Creates a PayPal billing agreement for a customer.

Access Scopes

`write_customers` access scope. Also: Requires `write_customer_payment_methods` scope.

Arguments

• billingAddress: MailingAddressInput - The billing address.
• billingAgreementId: String! - The billing agreement ID from PayPal that starts with 'B-' (for example, `B-1234XXXXX`).
• customerId: ID! - The ID of the customer.
• inactive: Boolean - Whether the PayPal billing agreement is inactive.

Returns

• customerPaymentMethod: CustomerPaymentMethod The customer payment method.
• userErrors: CustomerPaymentMethodUserError! The list of errors that occurred from executing the mutation.

Examples