API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

CustomerPaypalBillingAgreement object

Version unstable

Represents a PayPal instrument for customer payment method.

Required access

read_customers access scope.

On this page

Fields

  • The billing address of this payment method.

  • inactive (Boolean!)

    Whether the PayPal billing agreement is inactive.

  • isRevocable (Boolean!)

    Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts.

  • paypalAccountEmail (String)

    The customers's PayPal account email address.

Version 2021-07 (Release candidate)

Represents a PayPal instrument for customer payment method.

Required access

read_customers access scope.

On this page

Fields

  • The billing address of this payment method.

  • inactive (Boolean!)

    Whether the PayPal billing agreement is inactive.

  • isRevocable (Boolean!)

    Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts.

  • paypalAccountEmail (String)

    The customers's PayPal account email address.