Skip to main content

Interface: CreatePaymentMethodRequest

Extends​

Properties​

address_ids?​

optional address_ids: number[]

Array of address ids the new payment methods should be associated to

apply_to_all_subscription_addresses?​

optional apply_to_all_subscription_addresses: boolean

Whether to apply the payment method to all existing subscription addresses

billing_address?​

optional billing_address: AssociatedAddress

An object with the customer’s address information.

Inherited from​

PaymentMethod.billing_address

default?​

optional default: boolean

If this is the default payment method for the customer

Inherited from​

PaymentMethod.default

external_mandate_id?​

optional external_mandate_id: string

like “mandate_1O7lt8FHTwP5c651R…”

external_payment_method_id?​

optional external_payment_method_id: string

The external payment method id

payment_method_intent_id?​

optional payment_method_intent_id: string

The payment method intent id

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.

Inherited from​

PaymentMethod.payment_type

processor_customer_token​

processor_customer_token: string

The customer token at the processor.

Inherited from​

PaymentMethod.processor_customer_token

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.

Inherited from​

PaymentMethod.processor_name

processor_payment_method_token​

processor_payment_method_token: string

The payment token at the processor.

Inherited from​

PaymentMethod.processor_payment_method_token