Smartapp.com

InAppzone Subscriptions

operations about InAppzone subscriptions

Creates an InAppzone Subscription

Request
Request Body schema: application/json
type
required
string

Type of the inAppZone subscription you want to create

Enum: "SmartApp" "Project" "AppZone"
name
required
string

Name of the inAppZone subscription

amount
required
number

Subscription amount i.e., amount you want to collect to access the subscription per month per user

Array of objects (inAppZoneSubscriptionExemptionData)

names of users, user groups, and companies you want to exempt from subscription fees

SmartAppID
string <uuid>

Unique id of the smartapp for which you want to associate the subscription to.

ProjectPath
string

Path of the project for which you want to associate the subscription to. Should include path along with the name. If the type is Project, then pass in this parameter

Responses
200

InAppZone Subscription was created

400

Invalid exemptions, name, type, amount, or project

402

Subscription already exists for the given project/smartapp

post/inappzonesubscription/create
Request samples
application/json
{
  • "type": "SmartApp",
  • "name": "MySmartAppSubscription",
  • "amount": 65.1,
  • "exemptions": [
    ],
  • "SmartAppID": "00000000-0000-0000-0000-000000000000",
  • "ProjectPath": "level1\\\\level1.1\\\\projectname"
}
Response samples
application/json
{
  • "uniqueID": "a1dd802f-555b-4616-ba06-8f3aebecd52a",
  • "type": "SmartApp",
  • "name": "string",
  • "amount": 0,
  • "status": "New"
}

Updates an existing inAppZone subscription

Request
query Parameters
uniqueID
required
string <uuid>

The unique identifier of the subscription

Example: uniqueID=00000000-0000-0000-0000-000000000000
name
string

Name that you want to give

Example: name=MyNewSubscription
amount
number

Subscription Amount

Example: amount=70.89
Responses
200

InAppZone Subscription was updated

400

Invalid amount, name, or uniqueID

post/inappzonesubscription/update
Request samples
Response samples
application/json
{
  • "uniqueID": "a1dd802f-555b-4616-ba06-8f3aebecd52a",
  • "type": "SmartApp",
  • "name": "string",
  • "amount": 0,
  • "status": "New"
}
activates an existing inAppZone Subscription
Request
query Parameters
uniqueID
required
string <uuid> 
The unique identifier of the subscription to be activated


 
 Example:  uniqueID=00000000-0000-0000-0000-000000000000
Responses
200
success


400
invalud uniqueId


post/inappzonesubscription/activate
Request samples
deactivates an existing inAppZone Subscription
Request
query Parameters
uniqueID
required
string <uuid> 
The unique identifier of the subscription to be deactivated


 
 Example:  uniqueID=00000000-0000-0000-0000-000000000000
Responses
200
success


400
Invalid uniqueId


post/inappzonesubscription/deactivate
Request samples
removes an existing inAppZone Subscription
Request
query Parameters
uniqueID
required
string <uuid> 
The unique identifier of the subscription to be activated


 
 Example:  uniqueID=00000000-0000-0000-0000-000000000000
Responses
200
success


400
invalid uniqueId


post/inappzonesubscription/remove
Request samples
Add or remove exemptoinps for an existing inAppZone Subscription
Request
query Parameters
uniqueID
required
string <uuid> 
The unique identifier of the subscription for which you want to add to exemptions


 
 Example:  uniqueID=00000000-0000-0000-0000-000000000000
required
Array of objects (inAppZoneSubscriptionExemptionData) 
Array of one or more exemptions that you want to add them to


 
Responses
200
success


400
Invalid exemption(s) or uniqueId


post/inappzonesubscription/addexemptions
Request samples
Add or remove exemptoinps for an existing inAppZone Subscription
Request
query Parameters
uniqueID
required
string <uuid> 
The unique identifier of the subscription for which you want to remove from exemptions


 
 Example:  uniqueID=00000000-0000-0000-0000-000000000000
required
Array of objects (inAppZoneSubscriptionExemptionData) 
Array of one or more exemptions that you want to add or remove from


 
Responses
200
success


400
Invalid exemption(s) or uniqueId


post/inappzonesubscription/removeexemptions
Request samples
Returns a subscription from the user's unique ID
Request
query Parameters
UniqueID
required
string <uuid> 
The unique identifier of the inAppZone subscription to be retrieved


 
 Example:  UniqueID=00000000-0000-0000-0000-000000000000
Responses
200
InAppZone Subscription was updated


400
Invalid uniqueId


get/inappzonesubscription/get/uniqueid
Request samples
Response samples
application/json
{
  • "uniqueID": "a1dd802f-555b-4616-ba06-8f3aebecd52a",
  • "type": "SmartApp",
  • "name": "string",
  • "amount": 0,
  • "status": "New",
  • "exemptions": [
    ],
  • "smartApp": {
    },
  • "project": {
    },
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updatedOn": "2019-08-24T14:15:22Z"
}
➔ Next to WorkFlow