Skip to main content
Set the workspace's default saved card

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

payment_method_id
string
required

Stripe payment method ID owned by the calling workspace.

Pattern: ^pm_[A-Za-z0-9_]+$

Response

The saved card, now the workspace default.

id
string
required
Pattern: ^pm_[A-Za-z0-9_]+$
brand
string | null
required if type = card

Card brand; absent for Link methods.

last4
string | null
required if type = card

Last four card digits; absent for Link methods.

Pattern: ^[0-9]{4}$
exp_month
integer | null
required if type = card

Card expiry month; absent for Link methods.

Required range: 1 <= x <= 12
exp_year
integer | null
required if type = card

Card expiry year; absent for Link methods.

Required range: 2000 <= x <= 9999
default
boolean

True for the workspace's one default saved card; absent on older services.

priority
integer

One-based charge order for automatic top-up; lower priorities are tried first.

Required range: x >= 1
type
enum<string>

Payment method type. Link is a card-backed method saved through Stripe Link.

Available options:
card,
link
email
string<email>
required if type = link

Link account email; present only when type is link.