AddPlatformPlan - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

name

string

required

price

number <double>

required

currency

object (ICommonCurrency)

required

name

string

required

symbol

string

required

frequency

enum<string>

required

Allowed values:

monthlyquarterlyannually

thumbnail

string | null

optional

privacy

object

optional

organizationId

string

required

enabled

boolean

required

modules

object

required

apiKeys

object (ICommonEnabledLimit)

required

dynamicDashboards

object (ICommonEnabledLimit)

required

employeeSpends

object (ICommonEnabledLimit)

required

contracts

object (ICommonEnabledLimit)

required

branch

object (ICommonEnabledLimit)

required

warehouse

object (ICommonEnabledLimit)

required

debitNotes

object (ICommonEnabledLimit)

required

deals

object (ICommonEnabledLimit)

required

leads

object (ICommonEnabledLimit)

required

emailRules

object (ICommonEnabledLimit)

required

activityLogs

object (ICommonEnabledLimit)

required

automatedReminders

object (ICommonEnabledLimit)

required

organizationBackups

object (ICommonEnabledLimit)

required

fileImports

object (ICommonEnabledLimit)

required

reports

object (ICommonEnabledLimit)

required

employeeLeaves

object (ICommonEnabledLimit)

required

creditNotes

object (ICommonEnabledLimit)

required

outwardPayments

object (ICommonEnabledLimit)

required

enquiry

object (ICommonEnabledLimit)

required

account

object (ICommonEnabledLimit)

required

payroll

object (ICommonEnabledLimit)

required

tasks

object (ICommonEnabledLimit)

required

projects

object (ICommonEnabledLimit)

required

documents

object (ICommonEnabledLimit)

required

purchaseOrders

object (ICommonEnabledLimit)

required

proposals

object (ICommonEnabledLimit)

required

items

object (ICommonEnabledLimit)

required

users

object (ICommonEnabledLimit)

required

discounts

object (ICommonEnabledLimit)

required

taxes

object (ICommonEnabledLimit)

required

invoice

object

required

settlements

object (ICommonEnabledLimit)

required

payments

object

required

orders

object (ICommonEnabledLimit)

required

services

object (ICommonEnabledLimit)

required

products

object (ICommonEnabledLimit)

required

expenses

object

required

employees

object (ICommonEnabledLimit)

required

assets

object (ICommonEnabledLimit)

required

vendors

object (ICommonEnabledLimit)

required

clients

object (ICommonEnabledLimit)

required

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (PlatformPlanDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

name

string

required

price

number <double>

required

annualPrice

number <double>

optional

currency

optional

frequency

enum<string>

required

Allowed values:

monthlyquarterlyannually

thumbnail

string | null

optional

isActive

boolean

required

modules

object

required

features

array [object {4}]

optional

message

string

optional

Example

{
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0,
    "_id": "string",
    "name": "string",
    "price": 0,
    "annualPrice": 0,
    "currency": {
      "name": "string",
      "symbol": "string"
    },
    "frequency": "monthly",
    "thumbnail": "string",
    "isActive": true,
    "modules": {
      "apiKeys": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "dynamicDashboards": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "employeeSpends": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "contracts": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "branch": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "warehouse": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "debitNotes": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "deals": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "leads": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "emailRules": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "activityLogs": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "automatedReminders": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "organizationBackups": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "fileImports": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "reports": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "employeeLeaves": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "creditNotes": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "outwardPayments": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "enquiry": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "account": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "payroll": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "tasks": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "projects": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "documents": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "purchaseOrders": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "proposals": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "items": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "users": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "discounts": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "taxes": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "invoice": {
        "limitFrequency": "total",
        "limitType": "count",
        "limit": 0,
        "recurring": {
          "enabled": true,
          "limit": 0,
          "limitType": "count",
          "limitFrequency": "total",
          "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
          }
        },
        "enabled": true,
        "type": "manual"
      },
      "settlements": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "payments": {
        "limitFrequency": "total",
        "limitType": "count",
        "limit": 0,
        "gateway": {
          "razorpay": true
        },
        "enabled": true
      },
      "orders": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "services": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "products": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "expenses": {
        "limitFrequency": "total",
        "limitType": "count",
        "limit": 0,
        "recurring": {
          "enabled": true,
          "limit": 0,
          "limitType": "count",
          "limitFrequency": "total",
          "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
          }
        },
        "enabled": true
      },
      "employees": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "assets": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "vendors": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      },
      "clients": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
          "per": "count",
          "price": 0,
          "allowed": true
        }
      }
    },
    "features": [
      {
        "addOn": "string",
        "limitations": [
          "string"
        ],
        "enabled": true,
        "title": "string"
      }
    ]
  },
  "message": "string"
}

🟢200Success