Business

Get the caller's business (branding + masked credential state)

Response Body

`application/json`

curl -X GET "https://example.com/api/business/me"

null

Update the caller's business branding

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length

slug?string

Length1 <= length

logoUrl?string|null

faviconUrl?string|null

primaryColor?string|null

accentColor?string|null

supportEmail?string|null

loginBackgroundUrl?string|null

themeConfig?

Response Body

`application/json`

curl -X PUT "https://example.com/api/business/me" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true}

Set BYO credentials (Twilio / Grok) — write-only, encrypted at rest

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

twilioSid?string|null

twilioAuth?string|null

grokApiKey?string|null

stripeMode?string

Value in

"connect"
"keys"

stripeConnectAccountId?string|null

stripePublishableKey?string|null

stripeSecretKey?string|null

stripeWebhookSecret?string|null

Response Body

`application/json`

curl -X PUT "https://example.com/api/business/me/credentials" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true}

Test a BYO credential connection (Twilio, Grok, or Clover)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Value in

"twilio"
"grok"
"clover"

twilioSid?string

twilioAuth?string

grokApiKey?string

cloverMid?string

cloverToken?string

Response Body

`application/json`

curl -X POST "https://example.com/api/business/me/credentials/test" \  -H "Content-Type: application/json" \  -d '{    "type": "twilio"  }'

{  "success": true,  "message": "string"}

Upload business logo to Bunny Storage or return data URL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?file

Formatbinary

Response Body

`application/json`

curl -X POST "https://example.com/api/business/me/upload-logo"

{  "success": true,  "logoUrl": "string"}

Upload business favicon to Bunny Storage or return data URL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?file

Formatbinary

Response Body

`application/json`

curl -X POST "https://example.com/api/business/me/upload-favicon"

{  "success": true,  "faviconUrl": "string"}

Create a Stripe Connect onboarding link for the business

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

returnPath?string

Response Body

`application/json`

curl -X POST "https://example.com/api/business/stripe/connect" \  -H "Content-Type: application/json" \  -d '{}'

{  "url": "string"}

Get the business's Stripe Connect onboarding status

Response Body

`application/json`

curl -X GET "https://example.com/api/business/stripe/status"

{  "connected": true,  "accountId": "string",  "chargesEnabled": true,  "detailsSubmitted": true}

List the business's restaurant pricing plans

Response Body

`application/json`

curl -X GET "https://example.com/api/business/plans"

{  "plans": [    null  ]}

Create a restaurant pricing plan (creates Stripe Prices on the business account)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

monthlyPrice?number|string|null

yearlyPrice?number|string|null

currency?string

Default"usd"

trialDays?integer

Range0 <= value

Default0

Response Body

`application/json`

curl -X POST "https://example.com/api/business/plans" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

null

Delete a restaurant pricing plan

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/business/plans/string"

{  "success": true}

Update a restaurant pricing plan (price changes create new Stripe Prices)

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length

monthlyPrice?number|string|null

yearlyPrice?number|string|null

currency?string

trialDays?integer

Range0 <= value

active?boolean

Response Body

`application/json`

curl -X PUT "https://example.com/api/business/plans/string" \  -H "Content-Type: application/json" \  -d '{}'

null

Get pricing dashboard statistics (MRR, restaurant breakdown, etc.)

Response Body

`application/json`

curl -X GET "https://example.com/api/business/plans/stats"

{  "mrr": 0,  "mrrGrowth": "string",  "subscribedRestaurants": 0,  "monthlyCount": 0,  "yearlyCount": 0,  "inFreeTrial": 0,  "trialConversionRate": "string",  "paymentsFailing": 0,  "amountAtRisk": 0}

List audit logs for the caller's business

Query Parameters

page?string

Default"1"

limit?string

Default"50"

Response Body

`application/json`

curl -X GET "https://example.com/api/business/audit-logs"

{  "logs": [    null  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

200application/json

200application/json

400application/json

403application/json

200application/json

403application/json

200application/json

403application/json

201application/json

403application/json

200application/json

403application/json

404application/json

200application/json

403application/json

404application/json

200application/json

403application/json

200application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`