Skip to content

Prana Partner API (1.0)

API Definition to Partner interact with Prana platform

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api.prana.software/

Country

Consult countries available in the app

Operations

Period

Consult subscription periods available in the app

Operations

Plan

Consult subscription plans available in the app

Operations

List subscription plans

Request

Get all subscription plans.

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/plan/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(ApiPlanListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​descriptionstring

Plan description.

Example: "PLAN Integral"
data[].​suggestedboolean

Suggested plan.

Example: true
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
}

Company

Manage company of your subscriptions

Operations

Subscription

Manage your subscriptions

Operations

State

Consult states available in the app

Operations