Skip to main content
GET
Get Business's plans

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:
org_plans
object[]

The exhaustive list of the organization's plans.

Example:
active_plans
object[]

The exhaustive list of active plans for the business.