Skip to main content

Suspend Subscription

Suspend the subscription with the option to renew it.

Request Parametersapplication/json
CancelWithReasonIdRequestModel
object
cancellationReasonId
integer
The predefined reason for the subscription cancellation request. Possible values with IDs:
1 - The price is too high.
2 - I no longer need this product.
3 - I am not satisfied with the product.
4 - I switched to another product.
5 - It isn't a priority right now.
6 - I subscribed by mistake.
8 - I am switching to another subscription plan.
reasonText
string
The custom reason for the subscription cancellation request. It is required if CancellationReasonId is not passed.
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that informs
about the subscription suspension reason, 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
CancelWithReasonIdResponseModel
object
request
object
cancellationReasonId
integer
The predefined reason for the subscription cancellation request. Possible values with IDs:
1 - The price is too high.
2 - I no longer need this product.
3 - I am not satisfied with the product.
4 - I switched to another product.
5 - It isn't a priority right now.
6 - I subscribed by mistake.
8 - I am switching to another subscription plan.
reasonText
string
The custom reason for the subscription cancellation request. It is required if CancellationReasonId is not passed.
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that informs
about the subscription suspension reason, 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
{
"cancellationReasonId": 1,
"reasonText": "sample string 1",
"sendCustomerNotification": true,
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"cancellationReasonId": 1,
"reasonText": "sample string 1",
"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
}