Skip to main content
SaasVersion: 2023-02-21

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available options2023-02-21

Path Parameters

locationIdstringrequired

Location ID to enable SaaS for

Example:AUKAtFVo0lWezBsBQ3FE

Body

stripeAccountIdstring

Stripe account id(Required only for SaaS V1)

Example:acct_1QDPY5FpU9DlKp7RQ8BXfywx
namestring

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

Example:John Doe
emailstring

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

stripeCustomerIdstring

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

Example:cus_1QDPY5FpU9DlKp7RQ8BXfywx
companyIdstringrequired
isSaaSV2booleanrequired

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

Example:true
contactIdstring

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

Example:1QDPY5FpU9DlKp7RQ8BXfywx
providerLocationIdstring

Agency Subaccount ID

Example:r06mdj4OrrERzYDvsOdh
descriptionstring

Description

Example:Description
saasPlanIdstring

Required only while pre-configuring saas subscription

Example:1QDPY5FpU9DlKp7RQ8BXfywx
priceIdstring

Required only while pre-configuring saas subscription

Example:price_1QDPY5FpU9DlKp7RQ8BXfywx

Response

SaaS enabled successfully for location

dataobjectrequired

Response data from the enable SaaS operation