Get Available Subscription Plans

get

https://gw.praxisgate.com/api/v1.3/subscription-plan/search

Query Params

merchant_id

string

required

length ≤ 50

Merchant API client account identifier.

application_key

string

required

length ≤ 32

Identifier of your application (website).

plan_id

string

length ≤ 32

Subscription Plan ID

name

string

length ≤ 32

Description of the subscription plan

billing_cycle

string

enum

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)

Allowed:

trial_period

integer

enum

Filter by trial period presence when searching subscription plans:

1 - trial period exists
0 - trial period does not exist

Allowed:

currency

array of strings

length ≤ 64

Filter by one or multiple currencies upto limit of 64.Example: USD, EUR

currency

subscription_plan_status

string

length ≤ 8

Subscription Plan Status. Available status options:

active - Activate the subscription plan.
inactive - Deactivate the subscription plan.
deleted - Delete the subscription plan

sort

string

length ≤ 32

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

page

integer

≥ 1

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

per_page

integer

Count of entities for one page

version

string

required

length ≤ 3

API version.

timestamp

integer

required

Request time (unix timestamp, seconds).

Headers

gt-authentication

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

200OK - Successful response

400Bad request - Missing signature

403Forbidden request - IP address not whitelisted