Skip to main content

Change Renewal Type

Update the subscription renewal type.

Post
https://store.payproglobal.com/api/Subscriptions/ChangeRenewalType
Request Parametersapplication/json
UpdateRenewalTypeRequestModel
object
renewalTypeId
integer
required
The new subscription renewal type you want to apply. The available type IDs: 1 - Manual, 2 - Auto.
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.
Response Parametersapplication/json
UpdateRenewalTypeResponseModel
object
request
object
renewalTypeId
integer
The new subscription renewal type you want to apply. The available type IDs: 1 - Manual, 2 - Auto.
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.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
  "renewalTypeId": 1,
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "request": {
    "renewalTypeId": 1,
    "subscriptionId": 1111111,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}