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',
slug: 'my-store',
description: 'My online store',
email: '[email protected]',
phone: '+1234567890',
website: 'https://mystore.com',
address: {
  line1: '123 Main St',
  city: 'New York',
  state: 'NY',
  postalCode: '10001',
  country: 'US'
},
settings: {
  currency: 'USD',
  locale: 'en-US'
}
});

Update Business

Update business settings.

const result = await sdk.business.updateBusiness({
id: 'biz_abc123',
key: 'my-updated-store',
networkKey: null,
timezone: 'America/New_York',
status: 'ACTIVE',
configs: {
  webhookUrl: 'https://yourapp.com/webhooks',
  webhookEvents: ['order.created', 'order.paid']
}
});

Delete Business

Permanently delete a business and all associated data.

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

Business Hierarchy

Get Parent Businesses

Retrieve the parent chain for a business.

const parents = await sdk.business.getBusinessParents({});

// Returns array from immediate parent to root
parents.forEach(parent => {
  console.log(parent.key);
});

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);
});

Get Current Subscription

Get the current subscription status for a business.

const subscription = await sdk.business.getSubscription({});

console.log(subscription.plan, subscription.status, subscription.currentPeriodEnd);

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: '[email protected]',
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'
});

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 reservation ID
amount: 1999  // Partial refund in cents
});

Business Events

Get Business Events

Retrieve business events for a specific entity type.

const result = await sdk.business.getBusinessEvents({
  entity: 'order',
  limit: 50,
  cursor: null
});

result.items.forEach(event => {
  console.log(event.type, event.payload);
});

Update Business Event Payload

Update the payload of a business event.

await sdk.business.updateBusinessEventPayload({
  eventId: 'evt_abc123',
  payload: {
    type: 'email',
    templateKey: 'order-confirmation',
    recipients: ['[email protected]']
  }
});

Build Triggers

Trigger Builds

Trigger connected CI/CD builds (e.g., for static site regeneration).

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