The PUT /api/v1.3/subscription-plan/{planId}/prices method is used to create a new Price pair (amount+currency) in the existing subscription plan.
The planId must be included as part of the URL path.
The currency
parameter must be unique—you cannot create multiple price records with the same currency.
If you need to create a new price with the same currency, you must first remove the existing one.
The system only allows configuration of currencies that are present in the merchant’s gateway settings, and only for gateways where MIT is enabled.
Cryptocurrencies are not supported.
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 |
✓ - 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) |
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) |
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
merchant_id
application_key
timestamp
Response signature parameters
status
timestamp
{
"merchant_id": "API-Merchant",
"application_key": "test-application",
"amount": 50000,
"currency": "GBP",
"version": 1.3,
"timestamp": 1680712861
}
{
"status": 0,
"description": "Price ID 6495e1029a7bdwers74 successfully added.",
"version": 1.3,
"timestamp": 1680712861
}
{
"status": -1,
"description": "Currency GBP already defined for plan i2VANeFxKR1aZGoH."
}