GetAllPlatformSubscriptions

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

searchText

string

optional

active

boolean

optional

isTrial

boolean

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

createdAt

sortOrder

number <double>

optional

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/platform-subscription?searchText&active&isTrial' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array [array]

required

object (PlatformSubscriptionDocumentJSON)

optional

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        [
            {
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "__v": 0,
                "_id": "string",
                "organization": {
                    "id": "string",
                    "organizationId": "string",
                    "name": "string",
                    "state": "string"
                },
                "isTrial": true,
                "startDate": "2019-08-24T14:15:22Z",
                "endDate": "2019-08-24T14:15:22Z",
                "plan": {
                    "frequency": "monthly",
                    "currency": {
                        "name": "string",
                        "symbol": "string"
                    },
                    "price": 0,
                    "name": "string",
                    "id": "string"
                },
                "autoRenew": true,
                "deactivate": {
                    "reason": "string",
                    "date": "2019-08-24T14:15:22Z",
                    "enabled": true
                },
                "invoiceUrl": "string"
            }
        ]
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success