Docs/User API/Payment methods/Object

The payment method object

A link to an external payment method (e.g. credit card, bank account).

  • id

    string

    The system-assigned identifier of the payment method.

  • type

    enum

    The payment method type.

    Possible values:
    CARDUNKNOWN
  • displayName

    string

    A human-readable description of the payment method.

    This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.

  • fullName

    string

    The full name of the owner of the payment method.

  • address

    Address

    The address for the payment method.

  • default

    boolean

    Whether the payment method is the default for the account.

  • lastPaymentError

    Status

    The last payment error.

    This will be unset if the payment method is updated or if a payment succeeds.

  • card

    CardPaymentMethod

    Card payment method (e.g. Visa credit card).

  • createTime

    date-time

    The creation time of the payment method connection.

  • updateTime

    date-time

    The last update time of the payment method connection.

PreviousPayment methods
NextList payment methods

Build software thatmonetizes
$

Subscribe to monthly product updates

© 2025 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & custom auth