customerPaymentMethodPaypalBillingAgreementCreate
mutation

Choose a version:

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Creates a PayPal billing agreement for a customer.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'CustomerPaymentMethodPaypalBillingAgreementCreatePayload returns'

CustomerPaymentMethodPaypalBillingAgreementCreatePayload returns

Anchor to CustomerPaymentMethodPaypalBillingAgreementCreatePayload.customerPaymentMethod customerPaymentMethod CustomerPaymentMethod: The customer payment method.
Anchor to CustomerPaymentMethodPaypalBillingAgreementCreatePayload.userErrors userErrors [CustomerPaymentMethodUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: customerPaymentMethodPaypalBillingAgreementCreate

Query Reference for MUTATION: customerPaymentMethodPaypalBillingAgreementCreate

"mutation customerPaymentMethodPaypalBillingAgreementCreate($billingAgreementId: String!, $customerId: ID!) {\n  customerPaymentMethodPaypalBillingAgreementCreate(billingAgreementId: $billingAgreementId, customerId: $customerId) {\n    customerPaymentMethod {\n      # CustomerPaymentMethod fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerPaymentMethodPaypalBillingAgreementCreate

"{\n  \"billingAddress\": {\n    \"address1\": \"<your-address1>\",\n    \"address2\": \"<your-address2>\",\n    \"city\": \"<your-city>\",\n    \"company\": \"<your-company>\",\n    \"countryCode\": \"AC\",\n    \"firstName\": \"<your-firstName>\",\n    \"lastName\": \"<your-lastName>\",\n    \"phone\": \"<your-phone>\",\n    \"provinceCode\": \"<your-provinceCode>\",\n    \"zip\": \"<your-zip>\"\n  },\n  \"billingAgreementId\": \"<your-billingAgreementId>\",\n  \"customerId\": \"gid://shopify/<objectName>/10079785100\",\n  \"inactive\": true\n}"

Schema Reference for MUTATION: customerPaymentMethodPaypalBillingAgreementCreate

"input MailingAddressInput {\n  address1: String\n  address2: String\n  city: String\n  company: String\n  country: String\n  countryCode: CountryCode\n  firstName: String\n  id: ID\n  lastName: String\n  phone: String\n  province: String\n  provinceCode: String\n  zip: String\n}\n"

Display Examples for MUTATION: customerPaymentMethodPaypalBillingAgreementCreate

[]

customerPaymentMethodPaypalBillingAgreementCreatemutation

Arguments

CustomerPaymentMethodPaypalBillingAgreementCreatePayload returns

customerPaymentMethodPaypalBillingAgreementCreate
mutation