Methods
(route) listChangelogArticles()
Route:
| Method | Path |
|---|
| GET |
/api/misc/changelog |
Retrieve the changelog articles
Response:
| Name |
Type |
Description |
| changelog |
Array |
articles |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 400 |
Invalid params |
(route) retrieveCompany()
Route:
| Method | Path |
|---|
| POST |
/api/misc/stripe/retrieveCompany |
Fetch details about a company from its VAT ID
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| vat_id |
String |
the vat id of the company |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Response:
| Name |
Type |
Description |
| . |
Object |
metadata about company |
Response Code:
| Type |
Description |
| 500 |
stripe error |
| 200 |
succesfully retrieved the metadata |
(route) retrieveCoupon()
Route:
| Method | Path |
|---|
| POST |
/api/misc/stripe/retrieveCoupon |
Fetch details about a stripe coupon
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| coupon |
String |
the coupon name |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Response:
| Name |
Type |
Description |
| coupon |
Object |
the coupon object |
Response Code:
| Type |
Description |
| 500 |
stripe error |
| 200 |
succesfully retrieved the metadata |
(route) retrieveNodeRelease(:version)
Route:
| Method | Path |
|---|
| GET |
/api/misc/release/nodejs/:version |
Retrieve a list of nodejs release based on its version
Route Parameters:
| Name |
Type |
Description |
| :version |
String |
semver version range |
Response:
| Name |
Type |
Description |
| . |
Array |
array of releases matching the range requested |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 400 |
Invalid params |
Parameters:
| Name |
Type |
Description |
:version |
|
semver version range |
(route) retrievePlans()
Route:
| Method | Path |
|---|
| GET |
/api/misc/plans |
Retrieve the list of plans
Response:
| Name |
Type |
Description |
| . |
Object |
list of plans keyed by plan name |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 400 |
Invalid params |
(route) retrievePM2Version()
Route:
| Method | Path |
|---|
| GET |
/api/misc/release/pm2 |
Retrieve the latest pm2 version
Response:
| Name |
Type |
Description |
| pm2_version |
String |
latest version |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 400 |
Invalid params |
(route) retrieveVAT()
Route:
| Method | Path |
|---|
| POST |
/api/misc/stripe/retrieveVat |
Fetch VAT percentage for a country
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| country |
String |
optional |
country code of the user |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Response:
| Name |
Type |
Description |
| coupon |
Object |
the coupon object |
Response Code:
| Type |
Description |
| 500 |
stripe error |
| 200 |
succesfully retrieved the metadata |