Get subscription types

Gets a list of all subscription type.

get

Query parameters

NamestringOptional

The name to filter.

Unitstring · enumOptional

Represents the unit of time used for a subscription period.

Possible values:

Statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

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

Specifies the sorting order type for a collection.

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

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

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

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/subscription-types

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": []
}