Skip to main content
POST
Add 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.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

A new billing contact (at most 10 per account).

email
string<email>
required

Email address.

roles
enum<string>[]
required

At least one role.

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
name
string | null

Contact name.

Maximum string length: 120

Response

Created

Single-object envelope around a BillingContact.

data
object
required

A person or mailbox that receives billing emails.