Skip to main content
PATCH
Update a billing contact
Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Path Parameters

billingContactId
integer<uint64>
required

Id of the billing contact. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

JSON Merge Patch of a billing contact. The email is immutable.

name
string | null

Contact name; null clears it.

Maximum string length: 120
roles
enum<string>[]

New roles (at least one).

Minimum array length: 1

Which emails the contact receives. Treat as an open set: new values may be added.

Available options:
invoices,
dunning,
payment-failures

Response

OK

Single-object envelope around a BillingContact.

data
object
required

A person or mailbox that receives billing emails.