Skip to main content
SaaSVersion: v3

Get Location Subscription Details

GET/saas/get-saas-subscription/{locationId}

Fetch subscription details for a specific location from location metadata

Authorizations

Authorizationstringheaderrequired

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

Scope:saas/company.read
Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Query Parameters

companyIdstringrequired

Response

Subscription details for the sub-account.

locationIdstringrequired

Location ID

Example:locationId1
isSaaSV2booleanrequired

Indicates if the SaaS is V2

Example:true
companyIdstringrequired

Company ID

Example:companyId1
saasModestring

SaaS mode

Example:saasV2
subscriptionIdstring

Subscription ID

Example:subscriptionId1
customerIdstring

Customer ID

Example:customerId1
productIdstring

Product ID

Example:productId1
priceIdstring

Price ID

Example:priceId1
saasPlanIdstring

SaaS plan ID

Example:saasPlanId1
subscriptionStatusstring

Subscription status

Example:active