Skip to main content

Change Recurring Price

Update the subscription recurring price.

Request Parametersapplication/json
UpdatePriceRequestModel
object
newPriceValue
number
The new subscription recurring price that you want to apply.
priceCurrencyCode
string
The subscription currency code.
It must be equal to the current subscription currency code.
List of supported currency codes at PayPro Global.
quantity
integer
The new product quantity that you want to apply.
newSubscriptionName
string
The new name for a subscription that you want to apply.
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that
informs about the changed subscription details, false otherwise.
By default, the customer doesn't receive any email notification.
subscriptionId
integer
required
The subscription ID that needs to be updated.
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
UpdatePriceResponseModel
object
request
object
newPriceValue
number
The new subscription recurring price that you want to apply.
priceCurrencyCode
string
The subscription currency code.
It must be equal to the current subscription currency code.
List of supported currency codes at PayPro Global.
quantity
integer
The new product quantity that you want to apply.
newSubscriptionName
string
The new name for a subscription that you want to apply.
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that
informs about the changed subscription details, false otherwise.
By default, the customer doesn't receive any email notification.
subscriptionId
integer
The subscription ID that needs to be updated.
vendorAccountId
integer
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
"newPriceValue": 49.95,
"priceCurrencyCode": "USD",
"quantity": 1,
"newSubscriptionName": "Monthly premium subscription plan plus 5 extra packages",
"sendCustomerNotification": true,
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"newPriceValue": 49.95,
"priceCurrencyCode": "USD",
"quantity": 1,
"newSubscriptionName": "Monthly premium subscription plan plus 5 extra packages",
"sendCustomerNotification": true,
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
},
"errors": [
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
},
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
}
],
"isSuccess": false
}