Skip to main content

Renew Subscription

Renew the subscription. Only the subscriptions with the status Suspended can be renewed.

Request Parametersapplication/json
UpdateWithReasonMessageRequestModel
object
reasonText
string
The custom reason text for the subscription renewal request.
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
UpdateWithReasonMessageResponseModel
object
request
object
reasonText
string
The custom reason text for the subscription renewal request.
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
{
"reasonText": "sample string 1",
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"reasonText": "sample string 1",
"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
}