APPS REST API

Create App

Creates a new app with a given name and returns its ID. You can create as many apps as you like.

POST /apps/create

Request Data

{ "name": "new foo app" }

Response Data

{ "id": "dev_app_Cv7LsR57Lyx_Ua5JOvQhXT" }

Retrieve App Details

Retrieve all details of an app.

GET /apps/{appID}

Response Data

{ "app": { "id": "dev_app_Cv7LsR57Lyx_Ua5JOvQhXT", "name": "new foo app", "appPublishableKey": "ZGV2X2N1c196RF9iMDBmSFRkWlpWMzE3MUFOX2lfLmRldl9hcHBfQ3Y3THNSNTdMeXhfVWE1Sk92UWhYVA==", "appSecret": "dev_aps_yXEJO_7SyHgY27sKUIge1l0bpoec8y-C", "createdAt": "2019-08-14T12:13:05.585505Z", "updatedAt": "2019-08-14T12:13:05.585505Z" } }

Update App

Update the data field of an app. Make sure that the data field does not contain nested objects.

POST /apps/update/{appID}

Response Data

{}

List Apps

Returns a list of all apps and its details.

GET /apps

Response Data

{ "apps": [ { "id": "dev_app_qjcS0OG_iiOtLxFEhQ1-kZ", "name": "another app", "appPublishableKey": "ZGV2X2N1c196RF9iMDBmSFRkWlpWMzE3MUFOX2lfLmRldl9hcHBfcWpjUzBPR19paU90THhGRWhRMS1rWg==", "appSecret": "dev_aps_vy3njOctkMqtwK7YtqSBJJuXHGtItYTV", "createdAt": "2019-08-14T12:13:06.310673Z", "updatedAt": "2019-08-14T12:13:06.310673Z" }, { "id": "dev_app_Cv7LsR57Lyx_Ua5JOvQhXT", "name": "updated name", "appPublishableKey": "ZGV2X2N1c196RF9iMDBmSFRkWlpWMzE3MUFOX2lfLmRldl9hcHBfQ3Y3THNSNTdMeXhfVWE1Sk92UWhYVA==", "appSecret": "dev_aps_yXEJO_7SyHgY27sKUIge1l0bpoec8y-C", "config": { "baz": 3141, "foo": "bar" }, "createdAt": "2019-08-14T12:13:05.585505Z", "updatedAt": "2019-08-14T12:13:06.089656Z" } ] }

Delete App

Deletes an app

POST /apps/delete/{appID}

Response Data

{}

List Plans

Returns a list with all plans of an app

GET /{appID}

Response Data

{ "plans": [ { "id": "dev_pln_-py2iI0rjmrKjHaLzgrhh6", "appId": "dev_app_9iY09YKzV9oX1MEE3tb98u", "key": "", "name": "foo plan", "description": "bar desc", "state": "active", "data": { "currency": "US Dollar (USD)", "interval": "month", "pricePerUnit": "23.45" }, "createdAt": "2019-08-14T12:13:06.991351Z", "updatedAt": "2019-08-14T12:13:06.991351Z" }, { "id": "dev_pln_JvliuXT_RX2QDStnrhySmK", "appId": "dev_app_9iY09YKzV9oX1MEE3tb98u", "key": "", "name": "foo plan2", "description": "bar desc2", "state": "active", "createdAt": "2019-08-14T12:13:07.437231Z", "updatedAt": "2019-08-14T12:13:07.437231Z" } ] }

on this page: