The payment method object

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

A payment method represents a saved card or payment account belonging to a clinic client, used to pay for orders, invoices, and other charges.

brand

string | null

required

Brand of the card (e.g., Visa, Mastercard).

clinic_client_id

integer

required

The ID of the clinic client this payment method belongs to.

integer

required

The unique identifier for the payment method.

is_active

boolean

required

Whether the payment method is active.

is_expired

boolean

required

Whether the payment method is expired.

is_klarna

boolean

required

Whether the payment method is Klarna.

last_four

string | null

required

Last four digits of the card.

expiration_month

string | null

Card expiration month (1-12).

expiration_year

string | null

Card expiration year (4-digit).

name

string | null

Name on the card or payment account.

wallet

string | null

Wallet provider (e.g., Apple Pay, Google Pay).

⌘I

{
  "brand": "<string>",
  "clinic_client_id": 123,
  "id": 123,
  "is_active": true,
  "is_expired": true,
  "is_klarna": true,
  "last_four": "<string>",
  "expiration_month": "<string>",
  "expiration_year": "<string>",
  "name": "<string>",
  "wallet": "<string>"
}