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

CustomerPaymentMethod object

Version unstable

A customer's payment method.

Required access

read_customers access scope.

Connections

subscriptionContracts (SubscriptionContractConnection!)

List Subscription Contracts.
after ( String )

Returns the elements that come after the specified cursor.
before ( String )

Returns the elements that come before the specified cursor.
first ( Int )

Returns up to the first n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false

Fields

customer (Customer)

The customer to whom the payment method belongs.
id (ID!)

The ID of this payment method.
instrument (CustomerPaymentInstrument)

The instrument for this payment method.
revokedAt (DateTime)

The time that the payment method was revoked.

Types that return CustomerPaymentMethod

Mutations for CustomerPaymentMethod

customerPaymentMethodCreditCardCreate

Creates a credit card payment method for a customer.
customerPaymentMethodCreditCardUpdate

Updates the credit card payment method for a customer.
customerPaymentMethodRemoteCreditCardCreate

Create a payment method from a credit card stored by Stripe.
customerPaymentMethodRevoke

Revokes a customer's payment method.
customerPaymentMethodSendUpdateEmail

Sends a link to the customer so they can update a specific payment method.

Implements

Version unstable

Fields

edges ([CustomerPaymentMethodEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.

Types that return CustomerPaymentMethod

Mutations for CustomerPaymentMethod

customerPaymentMethodCreditCardCreate

Creates a credit card payment method for a customer.
customerPaymentMethodCreditCardUpdate

Updates the credit card payment method for a customer.
customerPaymentMethodRemoteCreditCardCreate

Create a payment method from a credit card stored by Stripe.
customerPaymentMethodRevoke

Revokes a customer's payment method.
customerPaymentMethodSendUpdateEmail

Sends a link to the customer so they can update a specific payment method.
Version unstable

Fields

cursor (String!)

A cursor for use in pagination.
node (CustomerPaymentMethod!)

The item at the end of CustomerPaymentMethodEdge.

Types that return CustomerPaymentMethod

Mutations for CustomerPaymentMethod

customerPaymentMethodCreditCardCreate

Creates a credit card payment method for a customer.
customerPaymentMethodCreditCardUpdate

Updates the credit card payment method for a customer.
customerPaymentMethodRemoteCreditCardCreate

Create a payment method from a credit card stored by Stripe.
customerPaymentMethodRevoke

Revokes a customer's payment method.
customerPaymentMethodSendUpdateEmail

Sends a link to the customer so they can update a specific payment method.
Version 2021-01 (Release candidate)

A customer's payment method.

Required access

read_customers access scope.

Connections

subscriptionContracts (SubscriptionContractConnection!)

List Subscription Contracts.
after ( String )

Returns the elements that come after the specified cursor.
before ( String )

Returns the elements that come before the specified cursor.
first ( Int )

Returns up to the first n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false

Fields

customer (Customer)

The customer to whom the payment method belongs.
id (ID!)

The ID of this payment method.
instrument (CustomerPaymentInstrument)

The instrument for this payment method.
revokedAt (DateTime)

The time that the payment method was revoked.

Types that return CustomerPaymentMethod

Mutations for CustomerPaymentMethod

customerPaymentMethodCreditCardCreate

Creates a credit card payment method for a customer.
customerPaymentMethodCreditCardUpdate

Updates the credit card payment method for a customer.
customerPaymentMethodRemoteCreditCardCreate

Create a payment method from a credit card stored by Stripe.
customerPaymentMethodRevoke

Revokes a customer's payment method.
customerPaymentMethodSendUpdateEmail

Sends a link to the customer so they can update a specific payment method.

Implements

Version 2021-01 (Release candidate)

On this page

Fields

edges ([CustomerPaymentMethodEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.
node (CustomerPaymentMethod!)

The item at the end of CustomerPaymentMethodEdge.

Types that return CustomerPaymentMethodEdge