Get subscription types

Gets a list of all subscription type.

get

Query parameters

NamestringOptional

The name to filter.

Unitstring · enumOptional

The unit to filter.

Possible values:

Statusstring · enumOptional

The status to filter.

Possible values:

TagsstringOptional

The tags to filter.

DescriptionstringOptional

The description to filter.

KeywordsstringOptional

The keywords to filter.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

The sort order to sort. By default, the value is Descending.

Possible values:

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/subscription-types HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "name": "Example Subscription Type",
      "unit": "Day",
      "quantity": 1,
      "tags": "Example Tags",
      "zOrder": 1,
      "status": "Active",
      "isDefault": true,
      "description": "Example Description"
    }
  ],
  "errors": []
}