Skip to content

Prana Partner API (1.0)

API definition for Partners to interact with the Prana platform

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api.prana.software/

State

Retrieves available states in the app

Operations

Company

Manage company of your subscriptions

Operations

Subscription

Manage your subscriptions

Operations

Country

Retrieves available countries in the app

Operations

Period

Retrieves the available subscription periods in the app

Operations

List subscription periods

Request

Retrieves the list of available subscription periods in the app.

Bodyapplication/jsonrequired
conditionobject(ApiCondition)
sortCriteriaArray of objects(ApiSortDto)

List of sorting criteria to apply

pageNumberinteger(int32)required

Page number to retrieve (0-based)

Example: 0
pageSizeinteger(int32)required

Number of items per page

Example: 20
curl -i -X POST \
  https://api.prana.software/api/v1/partner/period/search \
  -H 'Content-Type: application/json' \
  -d '{
    "condition": {
      "field": "name",
      "value": "Example Value",
      "type": "EQ",
      "endValue": 100,
      "innerConditions": [
        {}
      ],
      "conditionType": "AND",
      "empty": false,
      "compareFields": false
    },
    "sortCriteria": [
      {
        "sortField": "name",
        "sortDirection": "ASC"
      }
    ],
    "pageNumber": 0,
    "pageSize": 20
  }'

Responses

OK

Bodyapplication/json
dataArray of objects(ApiManagementPeriodListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​descriptionstring

Description period.

Example: "Anual"
data[].​monthsinteger(int32)

Months period

Example: 12
pageinteger(int32)required

Current page number (0-based)

Example: 0
totalinteger(int32)required

Total number of items across all pages

Example: 150
pagesinteger(int64)required

Last page number (0-based)

Example: 14
sizeinteger(int32)required

Number of items per page

Example: 10
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "total": 150,
  "pages": 14,
  "size": 10
}

Plan

Retrieves the available subscription plans in the app

Operations