Agencies
An agency's own key, its dealerships, and keys and webhooks for them. See "Agencies" above.
Get the agency
The agency an agency key belongs to, and the key's agency and dealer scopes. Agency keys only.
Get the agency's white label
The agency's own branding on its dealers' DMS: whether white label is
List the agency's dealerships
Every dealership the agency manages, newest first, with
Create a dealership
Creates a dealership on one of `GET /agency/prices`, billed exactly as
Get a dealership
One of the agency's dealerships. Scope `agency:dealerships:read`.
Update a dealership
Turns the dealership's website on or off. With `website: false` the
List a dealership's domains
The domains registered for or imported by a dealership. Scope `agency:domains:read`.
List the keys the agency made for a dealership
Active secret keys this agency created for the dealership. Scope `agency:keys:write`.
Create a secret key for a dealership
An ordinary secret key (`vh_live_sk_`, or `vh_test_sk_` with
Revoke a key the agency made for a dealership
Revokes it at once. Scope `agency:keys:write`.
List the prices a dealership can be created on
Active agency prices in the agency's currency. `unit_amount` is in minor units. Scope `agency:dealerships:write`.
List the agency's staff
The agency's own people. Scope `agency:staff:read`.
Get the agency's usage
What each dealership costs the agency over a period: its plan and its
List the agency's webhook endpoints
Endpoints that receive the events of every live dealership the agency manages. Scope `agency:webhooks:manage`.
Create an agency webhook endpoint
One endpoint for the events of all the agency's live dealerships.
Get an agency webhook endpoint
One endpoint, without its signing secret. Scope `agency:webhooks:manage`.
Update an agency webhook endpoint
Change its URL, description, events, or turn it off and on. Scope `agency:webhooks:manage`.
Delete an agency webhook endpoint
Stops deliveries from every dealership. Scope `agency:webhooks:manage`.
Roll an agency webhook endpoint's signing secret
Replaces the signing secret for every dealership's deliveries. The new secret is in this response only. Scope `agency:webhooks:manage`.