Update Card

Update, freeze, or cancel a card. Updating the card’s name, billing address, or limits requires both payout:account:update and company:balance:read; a card’s assigned holder may update their own card’s pin and frozen state with any user token.

PATCH /cards/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const card = await client.cards.update('id');

console.log(card.id);

200

{
  "billing": {
    "city": "Austin",
    "country_code": "US",
    "line1": "4180 Burnet Rd",
    "line2": "Suite 210",
    "postal_code": "78756",
    "region": "TX"
  },
  "canceled_at": "2026-01-01T12:00:00.000Z",
  "created_at": "2026-01-01T12:00:00.000Z",
  "expiration_month": "12",
  "expiration_year": "2027",
  "id": "icrd_xxxxxxxxxxxxxx",
  "last4": "4242",
  "limit": {
    "amount": 50,
    "frequency": "daily"
  },
  "name": "Detailing supplies",
  "object": "card",
  "spent_last_month": 1234,
  "status": "active",
  "type": "virtual",
  "user_id": "user_xxxxxxxxxxxxxx",
  "secrets": {
    "card_number": "<string>",
    "cvc": "<string>",
    "name_on_card": "<string>",
    "pin": "<string>"
  }
}

Authorizations

bearerAuthbearerAuth

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

Card ID to retrieve, prefixed icrd_.

Body

application/json

account_id · string

The owning account ID (a biz_ identifier). Provide this or user_id.

Example:

"biz_xxxxxxxxxxxxxx"

billing · object

New billing address. Requires line1, city, region, postal_code, and country_code. On an invited card, passing billing alone (as the invited user) completes onboarding and starts card provisioning.

Show child attributes

canceled · boolean

Pass true to permanently cancel the card. A canceled card cannot be uncanceled. Cannot be combined with other fields.

Example:

true

frozen · boolean

Pass true to freeze the card, false to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope.

Example:

true

name · string

A display name for the card.

Example:

"Detailing supplies"

pin · string

New 4-digit PIN. Can only be set on a card assigned to the acting user, who may set it without the payout:account:update scope.

Example:

"1234"

remove_limit · boolean

Pass true to remove the spending limit (make the card unlimited).

Example:

true

spend_limit · number

Spending limit amount, in dollars.

Example:

2500

spend_limit_frequency · enum<string>

The window the spend limit applies to.

Available options: daily, weekly, monthly, one_time

Example:

"monthly"

transaction_limit · number

Per-transaction limit amount, in dollars.

Example:

500

user_id · string

The owning user ID (a user_ identifier). Provide this or account_id.

Example:

"user_xxxxxxxxxxxxxx"

Response

200

application/json

invited card onboarding completed: card provisioning started

billing · object | null · required

The billing address.

Show child attributes

canceled_at · string<date-time> | null · required

When the card was canceled.

Example:

"2026-01-01T12:00:00.000Z"

created_at · string<date-time> | null · required

When the card was created.

Example:

"2026-01-01T12:00:00.000Z"

expiration_month · string | null · required

Card expiration month.

Example:

"12"

expiration_year · string | null · required

Card expiration year.

Example:

"2027"

id · string · required

Card ID, prefixed icrd_.

Example:

"icrd_xxxxxxxxxxxxxx"

last4 · string | null · required

Last four digits of the card number. null for pending invitation cards.

Example:

"4242"

limit · object | null · required

The spending limit configuration.

Show child attributes

name · string | null · required

Card display name.

Example:

"Detailing supplies"

object · enum<string> · required

Available options: card

Example:

"card"

spent_last_month · integer | null · required

Total spend in the last 30 days, in cents.

Example:

1234

status · enum<string> | null · required

The card status. denied means the issuer declined the cardholder, so the card will never be issued.

Available options: null, active, frozen, canceled, invited, denied

Example:

"active"

type · enum<string> | null · required

The card type.

Available options: null, virtual, physical

Example:

"virtual"

user_id · string | null · required

Cardholder user ID, prefixed user_, when assigned.

Example:

"user_xxxxxxxxxxxxxx"

secrets · object | null

Sensitive card details. Present only on GET /cards/:id for active cards; null when the card is inactive or details cannot be retrieved.

Show child attributes