← Saas operations · All schemas
Bulk Enable Saa S — saas bulk Enable Saas Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
bulkActionUrl | string | Optional | URL for the bulk enable SaaS operation |
message | string | Required within parent | Message indicating the bulk enable SaaS operation |
success | boolean | Required within parent | Indicates if the bulk enable SaaS operation was successful |
Bulk Enable Saa S — saas bulk Enable Saas — request body — body
Referenced models: Bulk Enable Saa S — saas bulk Enable Saas — request body — body action Payload price Id, provider Location Id, saas Plan Id, stripe Account Id
Bulk Enable Saa S — saas bulk Enable Saas — request body — body action Payload price Id, provider Location Id, saas Plan Id, stripe Account Id
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
priceId | string | Optional | Price ID for the SaaS plan |
providerLocationId | string | Optional | Provider location ID |
saasPlanId | string | Required within parent | SaaS plan ID |
stripeAccountId | string | Optional | Stripe account ID |
Disable Saa S for locations — saas bulk Disable Saas Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
data | object | Required within parent | Response data from the bulk disable SaaS operation |
Disable Saa S for locations — saas bulk Disable Saas — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
locationIds | array | Required within parent | Location IDs |
locationIds[] | string | Each item | |
Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
data | object | Required within parent | Response data from the enable SaaS operation |
Enable Saa S for Sub-Account (Formerly Location) — saas enable Saas Location — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyId | string | Required within parent | |
contactId | string | Optional | Agency subaccount used for payment provider integration(Required Only for SaaS V2) |
description | string | Optional | Description |
email | string | Optional | Email of the stripe customer(Required only for SaaS V1) |
isSaaSV2 | boolean | Required within parent | Denotes if it is a saas v2 or v1 sub-account |
name | string | Optional | Name of the stripe customer(Required only for SaaS V1) |
priceId | string | Optional | Required only while pre-configuring saas subscription |
providerLocationId | string | Optional | Agency Subaccount ID |
saasPlanId | string | Optional | Required only while pre-configuring saas subscription |
stripeAccountId | string | Optional | Stripe account id(Required only for SaaS V1) |
stripeCustomerId | string | Optional | Stripe customer id if exists(Required only for SaaS V1) |
Get Agency Plans — saas get Agency Plans Deprecated — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
addOns | array | Optional | Array of add-ons included in the plan |
addOns[] | string | Each item | |
categoryId | string | Optional | Category ID for the plan |
contactLimit | JSON | Optional | |
contactLimit (anyOf 1) | number | Alternative | Contact limit for the plan |
contactLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createdAt | string | Required within parent | Creation timestamp |
description | string | Required within parent | Description of the plan |
isSaaSV2 | boolean | Required within parent | Indicates if this is a SaaS V2 plan |
planId | string | Required within parent | Unique identifier for the plan |
planLevel | JSON | Required within parent | |
planLevel (anyOf 1) | number | Alternative | Level of the plan (0-4) |
planLevel (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
prices | array | Required within parent | Pricing information for the plan |
prices[] | object | Each item | |
prices[].active | boolean | Optional | Indicates if the price is active |
prices[].amount | JSON | Optional | |
prices[].amount (anyOf 1) | number | Alternative | Amount of the price |
prices[].amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
prices[].billingInterval | string | Optional | Billing interval for the plan
Known values: month, year |
prices[].currency | string | Optional | Currency of the price |
prices[].id | string | Optional | ID of the price |
prices[].symbol | string | Optional | Symbol of the price |
productId | string | Optional | Product ID for the plan |
providerLocationId | string | Optional | Provider location ID |
saasProducts | array | Required within parent | Array of SaaS products included in the plan |
saasProducts[] | string | Each item | |
snapshotId | string | Optional | Snapshot ID for the plan |
title | string | Required within parent | Title of the plan |
trialPeriod | JSON | Required within parent | |
trialPeriod (anyOf 1) | number | Alternative | Trial period in days |
trialPeriod (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updatedAt | string | Required within parent | Last update timestamp |
userLimit | JSON | Optional | |
userLimit (anyOf 1) | number | Alternative | User limit for the plan |
userLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get Location Subscription Details — saas get Location Subscription Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyId | string | Required within parent | Company ID |
customerId | string | Optional | Customer ID |
isSaaSV2 | boolean | Required within parent | Indicates if the SaaS is V2 |
locationId | string | Required within parent | Location ID |
priceId | string | Optional | Price ID |
productId | string | Optional | Product ID |
saasMode | string | Optional | SaaS mode |
saasPlanId | string | Optional | SaaS plan ID |
subscriptionId | string | Optional | Subscription ID |
subscriptionStatus | string | Optional | Subscription status |
Get Saa S Locations — saas get Saas Locations Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
locations | array | Required within parent | Array of SaaS locations |
locations[] | Model | Each item | Expand Get Saa S Locations — saas get Saas Locations Deprecated — response body — locations item |
pagination | object | Required within parent | |
pagination.hasNext | boolean | Optional | Indicates if there is a next page |
pagination.hasPrev | boolean | Optional | Indicates if there is a previous page |
pagination.limit | JSON | Optional | |
pagination.limit (anyOf 1) | number | Alternative | Number of items per page |
pagination.limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pagination.page | JSON | Optional | |
pagination.page (anyOf 1) | number | Alternative | Page number |
pagination.page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pagination.total | JSON | Optional | |
pagination.total (anyOf 1) | number | Alternative | Total number of items |
pagination.total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pagination.totalPages | JSON | Optional | |
pagination.totalPages (anyOf 1) | number | Alternative | Total number of pages |
pagination.totalPages (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get Saa S Locations — saas get Saas Locations Deprecated — response body — locations item
Get Saa S Locations — saas get Saas Locations Deprecated — response body — locations item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyId | string | Required within parent | Company ID |
customerId | string | Optional | Customer ID |
email | string | Optional | Email |
isSaaSV2 | boolean | Optional | Indicates if the SaaS is V2 |
locationId | string | Required within parent | Location ID |
name | string | Optional | Name |
providerLocationId | string | Optional | Provider location ID |
saasMode | string | Required within parent | SaaS mode |
subscriptionId | string | Required within parent | Subscription ID |
subscriptionInfo | object | Optional | Subscription information |
Get Saa S Plan — saas get Saas Plan Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
addOns | array | Optional | Array of add-ons included in the plan |
addOns[] | string | Each item | |
categoryId | string | Optional | Category ID for the plan |
companyId | string | Required within parent | Company ID associated with the SaaS plan |
contactLimit | JSON | Optional | |
contactLimit (anyOf 1) | number | Alternative | Contact limit for the plan |
contactLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createdAt | string | Required within parent | Creation timestamp
Format: date-time |
description | string | Required within parent | Description of the SaaS plan |
isSaaSV2 | boolean | Required within parent | Indicates if this is a SaaS V2 plan |
planId | string | Required within parent | Unique identifier for the SaaS plan |
planLevel | JSON | Required within parent | |
planLevel (anyOf 1) | number | Alternative | Level of the plan (0-4) |
planLevel (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
prices | array | Required within parent | Prices for the plan |
prices[] | object | Each item | |
prices[].active | boolean | Optional | |
prices[].amount | JSON | Optional | |
prices[].amount (anyOf 1) | number | Alternative | |
prices[].amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
prices[].billingInterval | string | Optional | Known values: month, year |
prices[].currency | string | Optional | |
prices[].id | string | Optional | |
prices[].symbol | string | Optional | |
productId | string | Optional | Product ID for the plan |
providerLocationId | string | Optional | Provider location ID |
saasProducts | array | Required within parent | Array of SaaS products included in the plan |
saasProducts[] | string | Each item | |
setupFee | JSON | Optional | |
setupFee (anyOf 1) | number | Alternative | Setup fee for the plan |
setupFee (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
snapshotId | string | Optional | Snapshot ID for the plan |
title | string | Required within parent | Title of the SaaS plan |
trialPeriod | JSON | Required within parent | |
trialPeriod (anyOf 1) | number | Alternative | Trial period in days |
trialPeriod (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updatedAt | string | Required within parent | Last update timestamp
Format: date-time |
userLimit | JSON | Optional | |
userLimit (anyOf 1) | number | Alternative | User limit for the plan |
userLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Pause location — saas pause Location — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyId | string | Required within parent | Company ID |
paused | boolean | Required within parent | Paused |
Update Location Wallet Balance — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
complimentaryCreditsAmount | number | Optional | Credit amount to be added |
Update Location Wallet Balance — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
balance | JSON | Required within parent | |
balance (anyOf 1) | number | Alternative | Current wallet balance |
balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
complimentaryCredits | JSON | Required within parent | |
complimentaryCredits (anyOf 1) | number | Alternative | Complimentary credits amount |
complimentaryCredits (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
walletId | string | Required within parent | Wallet Id |
Update Rebilling — saas update Rebilling Deprecated — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
success | boolean | Required within parent | Indicates if the rebilling update was successful |
Update Rebilling — saas update Rebilling — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
config | object | Required within parent | Configuration for rebilling settings |
config.enabled | boolean | Optional | Enable the rebilling for the locations |
config.markup | number | Optional | Additional value to be added in terms of percentage. For example, if the product price is $100 and the markup is 5, the amount charged to will be $105. |
config.optIn | boolean | Optional | Enable the product for the locations |
locationIds | array | Required within parent | Array of location IDs to update rebilling for |
locationIds[] | string | Each item | |
product | string | Required within parent | The product to update rebilling for
One of: contentAI, workflow_premium_actions, workflow_ai, conversationAI, EmailNotification, whatsApp, reviewsAI, VERIFIED_CALLER_ID, WALLET_SALES_TAX, NOTIFICATION_SMS, EmailSmtp, EmailVerification, autoCompleteAddress, funnelAI, domainPurchase, Phone, Email |
Update Saa S subscription — saas generate Payment Link — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyId | string | Required within parent | Company ID |
customerId | string | Required within parent | Customer ID |
subscriptionId | string | Required within parent | Subscription ID |
