Skip to main content

Finish Subscription

Stop the subscription permanently.

Request Parametersapplication/json
UpdateWithOptionalNotificationRequestModel
object
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that informs
about the reason for finishing the subscription, false otherwise.
By default, the customer doesn't receive any email notification.
reasonText
string
The custom reason for the subscription cancellation request.
It is required if CancellationReasonId is not passed.
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
UpdateWithOptionalNotificationResponseModel
object
request
object
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that informs
about the reason for finishing the subscription, false otherwise.
By default, the customer doesn't receive any email notification.
reasonText
string
The custom reason for the subscription cancellation request.
It is required if CancellationReasonId is not passed.
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
{
"sendCustomerNotification": true,
"reasonText": "sample string 1",
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"sendCustomerNotification": true,
"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
}