Schemas
- 01 Aug 2023
- 1 Minute to read
- Contributors
Schemas
- Updated on 01 Aug 2023
- 1 Minute to read
- Contributors
Article Summary
Share feedback
Thanks for sharing your feedback!
Request Headers
Each request must include the following request headers:
| Property | Data Type | Description |
|---|---|---|
| Authorization* | String | Your temporary Access Token obtained using the /authorize method |
| Content-Type* | String | application/json |
Request Body Schemas
Subscriptions
Create, Modify, and Add add-ons and subscriptions to a specific Perimeter 81 tenant. Each addon is a purchased license for a Member(s) or Gateway(s).
Addon
Information for a single addon. Found in Subscription.
| Property | Data Type | Description |
|---|---|---|
| amount* | Number | Number of new add-ons to purchase. |
| quantity* | Number | Total number of add-ons. |
| additionalType | String | Internal name of addon. |
| currencyCode | String | ISO currency code. Currently, only 'USD'. |
| pricingModel | String | Addon pricing model. One of:
|
| periodUnit* | String | Payment period. One of:
|
| status | String | Addon status. Value 'active'. |
| price* | Number | Price of the addon. |
| id* | String | ID of the addon. |
AddonStatistics
Statistics for a single addon. Found in AddonsStatisticsList.
| Property | Data Type | Description |
|---|---|---|
| remaining* | Number | Number of add-ons remaining. |
| expired* | Number | Number of add-ons that expired. |
| total* | Number | Total number of add-ons. |
| additionalType* | String | Internal name of addon. |
| used* | Number | Number of addons used. |
AddonsStatisticsList
List of statistics for all addons. Response to GET /v1/addons.
| Property | Data Type | Description |
|---|---|---|
| data* | Array of AddonStatistics | List of addon statistics. |
BuyAddonsDto
DTO for purchasing add-ons. Request body in POST /v1/addons/members and POST /v1/addons/gateways.
| Property | Data Type | Description |
|---|---|---|
| amount* | Integer | Number of add-ons to purchase. Minimum 1. |
Subscription
List of subscription add-ons. Response to POST /v1/addons/members and POST /v1/addons/gateways.
| Property | Data Type | Description |
|---|---|---|
| addons* | Array of Addon | List of subscription add-ons. |
| currencyCode* | String | ISO currency code. Currently, only 'USD'. |
| deleted* | Boolean | Whether the subscription is deleted (true). |
| status* | String | Status of subscription. One of:
|
| billingPeriodUnit* | String | Unit of the billing period. Currently, only '1'. |
| id* | String | ID of subscription. |
Was this article helpful?