Business

The Business module handles business configuration, subscription management, team invitations, and webhooks.

Get Business

Retrieve the current business.

const business = await sdk.business.getBusiness({});

console.log(business.key, business.settings);

List Businesses

List all businesses the current user has access to.

const result = await sdk.business.getBusinesses({
query: 'store',
isNetwork: false,
status: 'ACTIVE',
limit: 20,
cursor: null,
sortField: 'createdAt',
sortDirection: 'desc'
});

result.items.forEach(business => {
console.log(business.key);
});

Create Business

Create a new business.

const result = await sdk.business.createBusiness({
key: 'my-store',
timezone: 'America/New_York',
billingEmail: 'billing@mystore.com',
languages: [{ id: 'en' }],
emails: {
  billing: 'billing@mystore.com',
  support: 'support@mystore.com'
}
});

Three default markets are auto-created with every business: us (USD, Exclusive), eu (EUR, Inclusive), and booking (USD, Exclusive, no zones). Fetch them with sdk.market.list() or create additional markets with sdk.market.create().

Update Business

Update business settings.

const result = await sdk.business.updateBusiness({
id: 'biz_abc123',
key: 'my-updated-store',
timezone: 'America/New_York',
languages: [{ id: 'en' }],
emails: {
  billing: 'billing@yourstore.com',
  support: 'support@yourstore.com'
}
});

Delete Business

Permanently delete a business and all associated data.

await sdk.business.deleteBusiness({
  id: 'biz_abc123'
});

Subscriptions

Get Subscription Plans

List available subscription plans.

const plans = await sdk.business.getSubscriptionPlans({});

plans.forEach(plan => {
  console.log(plan.name, plan.price, plan.features);
});

Subscribe to Plan

Subscribe a business to a plan. Returns a Stripe checkout URL for payment.

const result = await sdk.business.subscribe({
planId: 'plan_pro',
successUrl: 'https://yourapp.com/subscription/success',
cancelUrl: 'https://yourapp.com/subscription/cancel'
});

// Redirect to Stripe checkout
if (result.url) {
window.location.href = result.url;
}

Create Billing Portal Session

Create a Stripe Customer Portal session for subscription management.

const result = await sdk.business.createPortalSession({
  returnUrl: 'https://yourapp.com/settings/billing'
});

// Redirect to Stripe portal
window.location.href = result.url;

Team Management

Invite User

Send an invitation to join the business team.

await sdk.business.inviteUser({
email: 'teammate@example.com',
role: 'Admin'  // 'Admin' | 'Owner' | 'Super'
});

Handle Invitation

Accept or decline an invitation.

// Accept invitation
await sdk.business.handleInvitation({
token: 'invitation_token_from_email',
action: 'ACCEPT'
});

// Reject invitation
await sdk.business.handleInvitation({
token: 'invitation_token_from_email',
action: 'REJECT'
});

Remove Member

Remove a team member from the business.

await sdk.business.removeMember({
  accountId: 'acc_abc123',
});

Webhooks

Test Webhook

Send a test webhook to verify your endpoint configuration.

await sdk.business.testWebhook({
webhook: {
  url: 'https://yourapp.com/webhooks',
  events: ['order.created', 'order.paid'],
  secret: 'whsec_...'
}
});

console.log('Webhook test sent successfully');

Media

Get Business Media

List all media files for a business.

const result = await sdk.business.getBusinessMedia({
  id: 'biz_abc123',
  limit: 50,
  cursor: null,
  query: 'product',
  mimeType: 'image/jpeg',
  sortField: 'createdAt',
  sortDirection: 'desc'
});

result.items.forEach(media => {
  console.log(media.id, media.url);
});

Refunds

Process Refund

Process a refund for a payment.

await sdk.business.processRefund({
id: 'biz_abc123',
entity: 'ord_xyz789',  // Order or booking ID
amount: 1999  // Partial refund in cents
});

Integrations

Manage third-party service integrations (Stripe, Shippo, Telegram, OpenAI, etc.).

List Integrations

const integrations = await sdk.business.listIntegrations({
  businessId: 'biz_abc123',
});

integrations.forEach(integration => {
  console.log(integration.key, integration.provider.type);
});

Create Integration

// Stripe payment integration
await sdk.business.createIntegration({
  businessId: 'biz_abc123',
  key: 'stripe-payments',
  provider: {
    type: 'stripe',
    secretKey: 'sk_live_...',
    publishableKey: 'pk_live_...',
    webhookSecret: 'whsec_...',
    currency: 'USD',
    activeForCardPayments: true,
  },
});

// Telegram bot integration
await sdk.business.createIntegration({
  businessId: 'biz_abc123',
  key: 'support-telegram',
  provider: {
    type: 'telegram_bot',
    botToken: '123456:ABC...',
  },
});

Update Integration

await sdk.business.updateIntegration({
  businessId: 'biz_abc123',
  id: 'int_xyz789',
  provider: {
    type: 'stripe',
    publishableKey: 'pk_live_new...',
    currency: 'EUR',
  },
});

Delete Integration

await sdk.business.deleteIntegration({
  businessId: 'biz_abc123',
  id: 'int_xyz789',
});

Get Integration Config

Get the active integration config for a specific category.

const paymentConfig = await sdk.business.getIntegrationConfig({
  businessId: 'biz_abc123',
  type: 'payment', // 'payment' | 'shipping' | 'analytics'
});

Available Provider Types

Plus 20+ more API-key providers (Airtable, Linear, GitHub, Notion, HubSpot, etc.).

Channel Integrations

For messaging channels (telegram_bot), incoming messages are routed to AI agents that have the integration’s ID in their channelIds array. See AI Agents for setting up agent routing.

OAuth

Connect and disconnect OAuth providers (e.g. Google) for a business.

OAuth Connect

await sdk.business.oauthConnect({
  businessId: 'biz_abc123',
  provider: 'google',
  code: 'auth_code_from_oauth_callback',
  redirectUri: 'https://yourapp.com/oauth/callback',
});

OAuth Disconnect

await sdk.business.oauthDisconnect({
  businessId: 'biz_abc123',
  provider: 'google',
});

Webhook CRUD

Manage webhook endpoints programmatically.

List Webhooks

const webhooks = await sdk.business.listWebhooks({
  businessId: 'biz_abc123',
});

Create Webhook

await sdk.business.createWebhook({
  businessId: 'biz_abc123',
  key: 'order-notifications',
  url: 'https://yourapp.com/webhooks/orders',
  events: [
    { event: 'order.created' },
    { event: 'order.updated' },
  ],
  headers: { 'X-Custom-Header': 'value' },
  secret: 'whsec_my_secret',
  enabled: true,
});

Update Webhook

await sdk.business.updateWebhook({
  businessId: 'biz_abc123',
  id: 'wh_xyz789',
  key: 'order-notifications',
  url: 'https://yourapp.com/webhooks/v2/orders',
  events: [
    { event: 'order.created' },
    { event: 'order.updated' },
    { event: 'order.cancelled' },
  ],
  headers: {},
  secret: 'whsec_new_secret',
  enabled: true,
});

Delete Webhook

await sdk.business.deleteWebhook({
  businessId: 'biz_abc123',
  id: 'wh_xyz789',
});

Available Webhook Events