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

Request

Version stringrequired

API Version

Available options2021-07-28

locationId stringrequired

Location ID to get subscription details for

companyId stringrequired

Company ID to filter subscription details

application/json

Location subscription details retrieved successfully

application/json

Schema

Schema

locationIdstringrequired

Location ID

isSaaSV2booleanrequired

Indicates if the SaaS is V2

companyIdstringrequired

Company ID

saasModestring

SaaS mode

subscriptionIdstring

Subscription ID

customerIdstring

Customer ID

productIdstring

Product ID

priceIdstring

Price ID

saasPlanIdstring

SaaS plan ID

subscriptionStatusstring

Subscription status

Example (auto)

{
  "locationId": "locationId1",
  "isSaaSV2": true,
  "companyId": "companyId1",
  "saasMode": "saasV2",
  "subscriptionId": "subscriptionId1",
  "customerId": "customerId1",
  "productId": "productId1",
  "priceId": "priceId1",
  "saasPlanId": "saasPlanId1",
  "subscriptionStatus": "active"
}