WebsitesApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:952
The Websites resource. Core CRUD + service introspection lives
directly on this class (list, get, create, delete, jobs,
services, logs). Everything else is grouped by concern under
sub-namespaces:
vc.websites.billing.*— Stripe subscription + invoicesvc.websites.commerce.*— Amazon analytics + Shopifyvc.websites.transfer.*— ownership transfer + collaborator invitevc.websites.deployment.*— Vercel deployment + redeployvc.websites.invitations.*— new-client invitation flow
Every method that used to live flat on WebsitesApi (e.g.
vc.websites.invoices, vc.websites.transfer) is still
available — it now delegates to the matching sub-namespace and is
marked @deprecated. Where the flat method name collides with a
sub-namespace name (transfer, deployment, invitations,
invoices), the property is a callable function-object: calling
it runs the deprecated flat method, and its own properties expose
the canonical namespace.
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebsitesApi(
opts):WebsitesApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:970
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebsitesApi
Overrides
Section titled “Overrides”Resource.constructor
Properties
Section titled “Properties”billing
Section titled “billing”
readonlybilling:WebsitesBillingApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:954
Stripe subscription + invoices.
clients
Section titled “clients”
readonlyclients:WebsitesClientAccessApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:964
“Add Client” access management (separate from transfer ownership).
commerce
Section titled “commerce”
readonlycommerce:WebsitesCommerceApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:956
Amazon analytics + Shopify connect/channels.
delivery
Section titled “delivery”
readonlydelivery:WebsitesDeliveryApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:966
Project delivery tracking (ETA, checkpoints, preview-URL gating).
deployment
Section titled “deployment”
readonlydeployment:WebsitesDeploymentNamespace
Defined in: packages/sdk/src/resources/WebsitesApi.ts:960
Vercel deployment + redeploy (callable: also the deprecated flat deployment(id)).
documents
Section titled “documents”
readonlydocuments:WebsitesDocumentsApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:968
Admin-uploaded project documents (contracts, briefs, etc.).
invitations
Section titled “invitations”
readonlyinvitations:WebsitesInvitationsNamespace
Defined in: packages/sdk/src/resources/WebsitesApi.ts:962
New-client invitation flow (callable: also the deprecated flat invitations(id)).
transfer
Section titled “transfer”
readonlytransfer:WebsitesTransferNamespace
Defined in: packages/sdk/src/resources/WebsitesApi.ts:958
Ownership transfer + collaborator invite (callable: also the deprecated flat transfer(id, input)).
Methods
Section titled “Methods”addShopifyChannel()
Section titled “addShopifyChannel()”addShopifyChannel(
websiteId,kind):Promise<{installUrl:string;kind:ShopifyChannelKind;label:string;shop:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1152
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
ShopifyChannelKind
Returns
Section titled “Returns”Promise<{ installUrl: string; kind: ShopifyChannelKind; label: string; shop: string; }>
amazonAnalytics()
Section titled “amazonAnalytics()”amazonAnalytics(
websiteId):Promise<AmazonCommerceState>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1047
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<AmazonCommerceState>
amazonSetupLink()
Section titled “amazonSetupLink()”amazonSetupLink(
websiteId):Promise<string|null>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1055
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<string | null>
billingPortal()
Section titled “billingPortal()”billingPortal(
websiteId):Promise<{url:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1115
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ url: string; }>
cancelInvite()
Section titled “cancelInvite()”cancelInvite(
websiteId):Promise<{website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1134
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ website: Website; }>
cancelTransfer()
Section titled “cancelTransfer()”cancelTransfer(
websiteId):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1083
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<Website>
connectShopify()
Section titled “connectShopify()”connectShopify(
websiteId,shop):Promise<{authUrl:string;redirectUri:string;shop:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1144
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
string
Returns
Section titled “Returns”Promise<{ authUrl: string; redirectUri: string; shop: string; }>
create()
Section titled “create()”create(
input):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1005
Parameters
Section titled “Parameters”CreateWebsiteInput
Returns
Section titled “Returns”Promise<Website>
delete()
Section titled “delete()”delete(
websiteId):Promise<{deleted:Record<string,unknown>;errors:object[];websiteId:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1013
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ deleted: Record<string, unknown>; errors: object[]; websiteId: string; }>
disconnectShopify()
Section titled “disconnectShopify()”disconnectShopify(
websiteId):Promise<{teardown: {errors:object[];feature:"shopify";removed: {envVars:string[];externalId?:string;oauthRows?:number;serviceRows:number;webhookSubs?:number; }; };website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1148
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ teardown: { errors: object[]; feature: "shopify"; removed: { envVars: string[]; externalId?: string; oauthRows?: number; serviceRows: number; webhookSubs?: number; }; }; website: Website; }>
disconnectStripe()
Section titled “disconnectStripe()”disconnectStripe(
websiteId):Promise<{website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1095
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ website: Website; }>
get(
websiteId):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1002
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<Website>
inviteClient()
Section titled “inviteClient()”inviteClient(
websiteId,input):Promise<{invitation:WebsiteInvitation;website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1130
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
string
Returns
Section titled “Returns”Promise<{ invitation: WebsiteInvitation; website: Website; }>
inviteCollaborator()
Section titled “inviteCollaborator()”inviteCollaborator(
websiteId):Promise<{invited:string;repo:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1138
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ invited: string; repo: string; }>
invoiceOneOff()
Section titled “invoiceOneOff()”invoiceOneOff(
websiteId,input):Promise<{invoice:WebsiteInvoice; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1103
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
amountUsd
Section titled “amountUsd”number
currency?
Section titled “currency?”string
description
Section titled “description”string
"send_invoice" | "charge_automatically"
Returns
Section titled “Returns”Promise<{ invoice: WebsiteInvoice; }>
invoices()
Section titled “invoices()”invoices(
websiteId):Promise<WebsiteInvoicesResponse>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1091
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<WebsiteInvoicesResponse>
jobs()
Section titled “jobs()”jobs(
websiteId):Promise<{jobs:ProvisioningJob[]; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1021
Provisioning job for a website (latest first).
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ jobs: ProvisioningJob[]; }>
list()
Section titled “list()”list():
Promise<{websites:Website[]; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:999
Returns
Section titled “Returns”Promise<{ websites: Website[]; }>
logs()
Section titled “logs()”logs(
websiteId,service):Promise<ServiceLogsResponse>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1029
Recent per-service activity logs (deployments, AI usage, etc.).
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
service
Section titled “service”string
Returns
Section titled “Returns”Promise<ServiceLogsResponse>
redeploy()
Section titled “redeploy()”redeploy(
websiteId):Promise<{deploymentId:string;readyState:string;url:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1079
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ deploymentId: string; readyState: string; url: string; }>
refreshAmazonAnalytics()
Section titled “refreshAmazonAnalytics()”refreshAmazonAnalytics(
websiteId,opts?):Promise<AmazonCommerceState>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1051
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
window?
Section titled “window?”number
Returns
Section titled “Returns”Promise<AmazonCommerceState>
refreshShopifyAnalytics()
Section titled “refreshShopifyAnalytics()”refreshShopifyAnalytics(
websiteId,opts?):Promise<ShopifyCommerceState>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1063
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
window?
Section titled “window?”number
Returns
Section titled “Returns”Promise<ShopifyCommerceState>
refreshShopifyChannels()
Section titled “refreshShopifyChannels()”refreshShopifyChannels(
websiteId):Promise<{changed:object[];checkedAt:string;websiteId:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1160
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ changed: object[]; checkedAt: string; websiteId: string; }>
removeShopifyChannel()
Section titled “removeShopifyChannel()”removeShopifyChannel(
websiteId,kind):Promise<{kind:ShopifyChannelKind;label:string;note:string;removed:true; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1156
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
ShopifyChannelKind
Returns
Section titled “Returns”Promise<{ kind: ShopifyChannelKind; label: string; note: string; removed: true; }>
resendTransfer()
Section titled “resendTransfer()”resendTransfer(
websiteId):Promise<{resent:true;sentTo:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1087
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ resent: true; sentTo: string; }>
restartBilling()
Section titled “restartBilling()”restartBilling(
websiteId,input?):Promise<{hostedInvoiceUrl:string|null;subscriptionId:string;website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1099
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
input?
Section titled “input?”monthlyPriceUsd?
Section titled “monthlyPriceUsd?”number
Returns
Section titled “Returns”Promise<{ hostedInvoiceUrl: string | null; subscriptionId: string; website: Website; }>
services()
Section titled “services()”services(
websiteId):Promise<{services:WebsiteService[]; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1025
Services (github/vercel/openrouter/…) currently provisioned.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ services: WebsiteService[]; }>
setFeatures()
Section titled “setFeatures()”setFeatures(
websiteId,patch):Promise<{job: {jobId:string; } |null;teardowns:object[];website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1040
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Partial<{ openrouter: boolean; resend: boolean; seo: boolean; }>
Returns
Section titled “Returns”Promise<{ job: { jobId: string; } | null; teardowns: object[]; website: Website; }>
setPrice()
Section titled “setPrice()”setPrice(
websiteId,input):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1123
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
monthlyPriceUsd
Section titled “monthlyPriceUsd”number
Returns
Section titled “Returns”Promise<Website>
shopifyAnalytics()
Section titled “shopifyAnalytics()”shopifyAnalytics(
websiteId):Promise<ShopifyCommerceState>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1059
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<ShopifyCommerceState>
shopifyWebhookHealth()
Section titled “shopifyWebhookHealth()”shopifyWebhookHealth(
websiteId):Promise<ShopifyWebhookHealth>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1067
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<ShopifyWebhookHealth>
subscribeShopifyWebhookHealth()
Section titled “subscribeShopifyWebhookHealth()”subscribeShopifyWebhookHealth(
websiteId,opts?):Promise<ShopifyWebhookHealth>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1071
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
topics?
Section titled “topics?”string[]
Returns
Section titled “Returns”Promise<ShopifyWebhookHealth>
unassign()
Section titled “unassign()”unassign(
websiteId):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1119
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<Website>
unsubscribeShopifyWebhookTopic()
Section titled “unsubscribeShopifyWebhookTopic()”unsubscribeShopifyWebhookTopic(
websiteId,topic):Promise<ShopifyWebhookHealth>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:1075
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
string
Returns
Section titled “Returns”Promise<ShopifyWebhookHealth>