API Reference

Get Available Subscription Plans

get
https://gw.praxisgate.com/api/v1.3/subscription-plan/search
Query Params
string
required
length ≤ 50

Merchant API client account identifier.

string
required
length ≤ 32

Identifier of your application (website).

string
length ≤ 32

Subscription Plan ID

string
length ≤ 32

Description of the subscription plan

string
length ≤ 14

The frequency of charging within the subscription plan. List of possible values:

  • Weekly (weekly)
  • Monthly (monthly)
  • Every 3 months (every_3_months)
  • Every 6 months (every_6_months)
  • Yearly (yearly)
integer
enum

Filter by trial period presence when searching subscription plans:

  • 1 - trial period exists
  • 0 - trial period does not exist
Allowed:
string
length ≤ 10

Base Currency: The user's account currency on the merchant site.

string
length ≤ 8

Subscription Plan Status. Default value - active

string
length ≤ 32

In case the value starts from minus (-), this means sorting by DESC

integer
≥ 1

Current results page. First page is 1; values lower than 1 are treated as 1.

integer

Count of entities for one page

string
required
length ≤ 3

API version.

integer
required

Request time (unix timestamp, seconds).

Headers
string
required

Authentication HTTP header of your outgoing request to the API. Below request parameters should be used for creating signature in request header.

  • merchant_id
  • application_key
  • timestamp
Responses

Updated 6 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago