Skip to main content

Do Recurring Payment

Make an additional subscription charge.

Request Parametersapplication/json
SubscriptionBaseRequestModel
object
subscriptionId
integer
required
The subscription ID for which you want to initiate an additional recurring charge.
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
SubscriptionBaseResponseModel
object
response
object
orderId
integer
The order ID that was created.
orderStatusName
string
The status name of the order that was created.
orderStatusId
integer
The status ID of the order that was created.
orderDeclineReason
string
The decline reason if the order was cancelled.
error
string
The error message if the order was cancelled.
request
object
subscriptionId
integer
Subscription id.
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
{
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"response": {
"orderId": 5458995,
"orderStatusName": "Processed",
"orderStatusId": 5,
"orderDeclineReason": "sample string 4",
"error": "sample string 5"
},
"request": {
"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
}