Skip to content

Set default payment method

POST
/portal/payment_methods/{payment_method_id}/set_default

Set a payment method as the default for the authenticated customer.

payment_method_id
required
Payment Method Id
string format: uuid
token
required
Token
string

Successful Response

PaymentMethodResponse
object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
provider
required
Provider
string
provider_payment_method_id
required
Provider Payment Method Id
string
type
required
Type
string
is_default
required
Is Default
boolean
details
required
Details
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Invalid or expired portal token

Payment method not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object