Skip to content
Karmo Developer Portal

Update a billing account

PATCH
/customers/{id}

Updates mutable billing-account fields. Currently only email is mutable; the value is persisted locally and synced to the payment provider via provider.updateCustomer.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Request Body required

Section titled “Request Body required ”
object
email
required

New email for the billing account.

string format: email

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Billing account updated

object
id
required
string format: uuid
userId
required
string
tenantId
required
string
email
string | null format: email
paymentGatewayId
required
string format: uuid
gatewayCustomerRef
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

404

Section titled “404 ”

Billing account not found

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required
string
pointer
required
string
karmoMeta
object
key
additional properties
any