Finish Subscription

Stop the subscription permanently.

Post

https://store.payproglobal.com/api/Subscriptions/Finish

Request Parametersapplication/json

UpdateWithOptionalNotificationRequestModel

object

sendCustomerNotification

boolean

optional

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

required

The reason of the subscription cancellation 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

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

required

The reason of the subscription cancellation 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

{
  "sendCustomerNotification": true,
  "reasonText": "your_cancellation_reason",
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}

Response Sample

{
  "request": {
    "sendCustomerNotification": true,
    "reasonText": "your_cancellation_reason",
    "subscriptionId": 1111111,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}