Skip to main content
GET
/
business
/
{business_id}
/
plans
Get Business's plans
curl --request GET \
  --url https://api.partoo.co/v2/business/{business_id}/plans \
  --header 'x-APIKey: <api-key>'
import requests

url = "https://api.partoo.co/v2/business/{business_id}/plans"

headers = {"x-APIKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-APIKey': '<api-key>'}};

fetch('https://api.partoo.co/v2/business/{business_id}/plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.partoo.co/v2/business/{business_id}/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-APIKey: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.partoo.co/v2/business/{business_id}/plans"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-APIKey", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.partoo.co/v2/business/{business_id}/plans")
.header("x-APIKey", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/business/{business_id}/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-APIKey"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "plans": [
    {
      "name": "presence_management",
      "enabled": true,
      "subscription_date": "2025-01-01",
      "expiration_date": "2026-01-01"
    },
    {
      "name": "review_management",
      "enabled": false,
      "subscription_date": "2025-01-01",
      "expiration_date": null
    }
  ],
  "org_plans": [
    {
      "name": "presence_management",
      "subscription_date": "2025-01-01",
      "expiration_date": "2026-01-01"
    },
    {
      "name": "review_management",
      "subscription_date": "2025-01-01",
      "expiration_date": null
    }
  ],
  "active_plans": [
    {
      "name": "presence_management",
      "expiration_date": "2026-01-01",
      "enabled": true,
      "subscription_date": "2025-01-01"
    }
  ]
}
{
"errors": {
"json": {}
}
}
{
"errors": {
"authentication": "User not authenticated"
}
}
{
"errors": {
"authorization": "Operation not allowed"
}
}

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

business_id
string
required

Business id.

It may be replaced by c-{code} where code is the store code, which should be unique per organization. This can be used only for ORG_ADMIN, GROUP_MANAGER and BUSINESS_MANAGER users.

Response

OK

plans
object[]

The exhaustive list of the business's plans.

Example:
[
{
"name": "presence_management",
"enabled": true,
"subscription_date": "2025-01-01",
"expiration_date": "2026-01-01"
},
{
"name": "review_management",
"enabled": false,
"subscription_date": "2025-01-01",
"expiration_date": null
}
]
org_plans
object[]

The exhaustive list of the organization's plans.

Example:
[
{
"name": "presence_management",
"subscription_date": "2025-01-01",
"expiration_date": "2026-01-01"
},
{
"name": "review_management",
"subscription_date": "2025-01-01",
"expiration_date": null
}
]
active_plans
object[]

The exhaustive list of active plans for the business.