Skip to main content

payment_methods

Overview

Namepayment_methods
TypeResource
Idlinode.account.payment_methods

Fields

NameDatatypeDescription
idintegerThe unique ID of this Payment Method.
createdstringWhen the Payment Method was added to the Account.
data``
is_defaultbooleanWhether this Payment Method is the default method for automatically processing service charges.
typestringThe type of Payment Method.

Methods

NameAccessible byRequired ParamsDescription
getPaymentMethodSELECTpaymentMethodIdView the details of the specified Payment Method.
getPaymentMethodsSELECTReturns a paginated list of Payment Methods for this Account.
createPaymentMethodINSERTdata__data, data__is_default, data__typeAdds a Payment Method to your Account with the option to set it as the default method.

Adding a default Payment Method removes the default status from any other Payment Method.

An Account can have up to 6 active Payment Methods.

Up to 60 Payment Methods can be added each day.

Prior to adding a Payment Method, ensure that your billing address information is up-to-date
with a valid zip by using the Account Update (PUT /account) endpoint.

* A payment_method_add event is generated when a payment is successfully submitted.
deletePaymentMethodDELETEpaymentMethodIdDeactivate the specified Payment Method.

The default Payment Method can not be deleted. To add a new default Payment Method, access the Payment Method
Add (POST /account/payment-methods) endpoint. To designate an existing
Payment Method as the default method, access the Payment Method Make Default
(POST /account/payment-methods/{paymentMethodId}/make-default)
endpoint.
_getPaymentMethodEXECpaymentMethodIdView the details of the specified Payment Method.
_getPaymentMethodsEXECReturns a paginated list of Payment Methods for this Account.
makePaymentMethodDefaultEXECpaymentMethodIdMake the specified Payment Method the default method for automatically processing payments.

Removes the default status from any other Payment Method.