Enable SaaS for Sub-Account (Formerly Location)

POST 
/saas-api/public-api/enable-saas/:locationId

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Enable SaaS for Sub-Account (Formerly Location) based on the data provided

info

This feature is only available on Agency Pro ($497) plan.

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

Location ID to enable SaaS for

application/json

application/json

Body

Bodyrequired

stripeAccountIdstring

Stripe account id(Required only for SaaS V1)

namestring

Name of the stripe customer(Required only for SaaS V1)

emailstring

Email of the stripe customer(Required only for SaaS V1)

stripeCustomerIdstring

Stripe customer id if exists(Required only for SaaS V1)

companyIdstringrequired
isSaaSV2booleanrequired

Denotes if it is a saas v2 or v1 sub-account

contactIdstring

Agency subaccount used for payment provider integration(Required Only for SaaS V2)

providerLocationIdstring

Agency Subaccount ID

descriptionstring

Description

saasPlanIdstring

Required only while pre-configuring saas subscription

priceIdstring

Required only while pre-configuring saas subscription

Example (auto)

{
  "stripeAccountId": "acct_1QDPY5FpU9DlKp7RQ8BXfywx",
  "name": "John Doe",
  "email": "[email protected]",
  "stripeCustomerId": "cus_1QDPY5FpU9DlKp7RQ8BXfywx",
  "companyId": "string",
  "isSaaSV2": true,
  "contactId": "1QDPY5FpU9DlKp7RQ8BXfywx",
  "providerLocationId": "r06mdj4OrrERzYDvsOdh",
  "description": "Description",
  "saasPlanId": "1QDPY5FpU9DlKp7RQ8BXfywx",
  "priceId": "price_1QDPY5FpU9DlKp7RQ8BXfywx"
}

application/json

SaaS enabled successfully for location

application/json

Schema

Schema

dataobjectrequired

Response data from the enable SaaS operation

Example (auto)

{
  "data": {
    "customer_id": "cus_1QDPY5FpU9DlKp7RQ8BXfywx",
    "ok": true,
    "paymentMethodAdded": true
  }
}