Skip to main content
SaasVersion: 2021-04-15

Get Location Subscription Details

GET/saas-api/public-api/get-saas-subscription/{locationId}
deprecated

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

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.

Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available options2021-04-15

Path Parameters

locationIdstringrequired

Location ID to get subscription details for

Example:AUKAtFVo0lWezBsBQ3FE

Query Parameters

companyIdstringrequired

Company ID to filter subscription details

Example:5DP4iH6HLkQsiKESj6rh

Response

Location subscription details retrieved successfully

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