Skip to main content
Docs

BillingPaymentMethodResource

Warning

Billing is currently in Beta and its APIs are experimental and may undergo breaking changes. To mitigate potential disruptions, we recommend pinning your SDK and clerk-js package versions.

The BillingPaymentMethodResource type represents a payment method for a checkout session.

Properties

  • Name
    cardType
    Type
    null | string
    Description

    The brand or type of card. For example, 'visa' or 'mastercard'.

  • Name
    createdAt?
    Type
    null | Date
    Description

    The date the payment method was created, if available.

  • Name
    expiryMonth?
    Type
    null | number
    Description

    The card expiration month, if available.

  • Name
    expiryYear?
    Type
    null | number
    Description

    The card expiration year, if available.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the payment method.

  • Name
    isDefault?
    Type
    boolean
    Description

    Whether the payment method is set as the default for the account.

  • Name
    isRemovable?
    Type
    boolean
    Description

    Whether the payment method can be removed by the user.

  • Name
    last4
    Type
    null | string
    Description

    The last four digits of the payment method.

  • Name
    makeDefault
    Type
    (params?: { orgId?: string; }) => Promise<null>
    Description

    A function that sets this payment method as the default for the account. Accepts the following parameters:

    • orgId? (string): The ID of the Organization to set as the default.
  • Name
    pathRoot
    Type
    string
    Description

    The root path of the resource.

  • Name
    paymentType?
    Type
    "card"
    Description

    The type of payment method. For example, 'card'.

  • Name
    remove
    Type
    (params?: { orgId?: string; }) => Promise<DeletedObjectResource>
    Description

    A function that removes this payment method from the account. Accepts the following parameters:

    • orgId? (string): The ID of the Organization to remove the payment method from.
  • Name
    status
    Type
    "active" | "expired" | "disconnected"
    Description

    The current status of the payment method.

  • Name
    updatedAt?
    Type
    null | Date
    Description

    The date the payment method was last updated, if available.

  • Name
    walletType?
    Type
    null | string
    Description

    The type of digital wallet, if applicable. For example, 'apple_pay', or 'google_pay'.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub