Skip to main content

Interface: PaymentMethod

Properties​

billing_address​

billing_address: AssociatedAddress

An object with the customer’s address information.

created_at​

created_at: string

The time the payment method was created.

customer_id​

customer_id: number

The Recharge customer_id

default​

default: boolean

If this is the default payment method for the customer

deleted_at?​

optional deleted_at: string

The time the payment method was deleted. This is only included if include_deleted is true.

id​

id: number

The unique payment method id for a customer.

include?​

optional include: object

Additional information as requested

addresses?​

optional addresses: Address[]

payment_details​

payment_details: PaymentDetails

Details about the specific payment method

payment_type​

payment_type: PaymentType

The type of payment this is. If passed, must also be accompanied by one of stripe_customer_token, paypal_customer_token or authorizedotnet_customer_token in processor_payment_method_token.

processor_customer_token​

processor_customer_token: string

The customer token at the processor.

processor_name​

processor_name: ProcessorName

This will impact validation on billing_details. Currently, shopify_payments is in read-only mode and can only be managed by Shopify.

processor_payment_method_token​

processor_payment_method_token: string

The payment token at the processor.

status​

status: PaymentMethodStatus

State of the Payment Method.

status_reason​

status_reason: string

The status reason for the payment method. Often used when invalid to provide background details in invalidity.

updated_at​

updated_at: string

The time the payment method was last updated.