Create Subscription Plan Price

PUT /api/v1.3/subscription-plan/{planId}/prices method is your endpoint to create a new Price pair (amount+currency) in the existing subscription plan. Plan ID should be sent as a part of the URL.

• The currency parameter should be unique, meaning the record with two identical currencies cannot be created. If you need to create price with same currency you need remove previous before.
• The system should allow configuring only the currencies that exist in the merchant's gateway settings, considering only the gateways with MIT enabled.
• Cryptocurrencies are not supported.
• ENDPOINTS
• REQUEST PARAMS
• RESPONSE PARAMS
• EXAMPLE

ENDPOINTS

Name	URL
Sandbox	https://pci-gw-test.praxispay.com/api/v1.3/subscription-plan/{planId}/prices
Live	https://gw.praxisgate.com/api/v1.3/subscription-plan/{planId}/prices

REQUEST PARAMS

✓ - required value
? - optional, value or null
✕ - always appears as null

Variable	Type		Description
merchant_id	varchar(50)	✓	Merchant API client account identifier
application_key	varchar(32)	✓	Identifier of your application (website)
amount	int(11)	✓	Price amount
currency	varchar(4)	✓	Price currency
version	varchar(4)	✓	API version. Default value - v1.3
timestamp	int(11)	✓	Response time (unix timestamp, seconds)

RESPONSE PARAMS

Variable	Type		Description
status	int	✓	API communication status - - 0 if the request was successful - Negative integer if internal server/network error occurs - Positive integer if application/logical error occurs
description	varchar(256)	✓	Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
version	varchar(3)	✓	API version
timestamp	int(11)	✓	Response time (unix timestamp, seconds)

Signature

To execute the request, it is necessary to undergo the authentication process. The general authentication algorithm can be found in the Authentication section.

Request signature parameters

1. merchant_id
2. application_key
3. timestamp

Response signature parameters

1. status
2. timestamp

Example

Request

{
  "merchant_id": "API-Merchant",
  "application_key": "test-application",
  "amount": 50000,
  "currency": "GBP",
  "version": 1.3,
  "timestamp": 1680712861
}

Response (successful scenario)

{
  "status": 0,
  "description": "Price ID 6495e1029a7bdwers74 successfully added.",
  "version": 1.3,
  "timestamp": 1680712861
}

Response (unsuccessful scenario)

{
  "status": -1,
  "description": "Currency GBP already defined for plan i2VANeFxKR1aZGoH."
}