Skip to main content

Bulk Terminate Subscriptions

Terminate the subscriptions in bulk.

Post
https://store.payproglobal.com/api/Subscriptions/BulkTerminateSubscriptions
Request Parametersapplication/json
BulkUpdateSubscriptionsRequestModel
object
subscriptionIds
array[integer]
required
The list of subscription IDs that need to be terminated.
sendVendorEmail
boolean
optional
Possible values are true or false.
If true, it sends a vendor an email that informs
about the subscription termination, false otherwise.
By default, no email notification is sent.
sendCustomerEmail
boolean
optional
Possible values are true or false.
If true, it sends a customer an email that informs
about the subscription termination, false otherwise.
By default, the customer doesn't receive any email notification.
sendIpn
boolean
optional
Possible values are true or false.
If true, it sends IPN/webhook notification: IPN_TYPE_ID=10,
IPN_TYPE_NAME=SubscriptionTerminated.
By default, no IPN/webhook notification is sent.
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
BulkUpdateSubscriptionsResponseModel
object
message
string
The notification on the API request processing.
request
object
subscriptionIds
array[integer]
required
The list of subscription IDs that need to be terminated.
sendVendorEmail
boolean
Possible values are true or false.
If true, it sends a vendor an email that informs
about the subscription termination, false otherwise.
By default, no email notification is sent.
sendCustomerEmail
boolean
Possible values are true or false.
If true, it sends a customer an email that informs
about the subscription termination, false otherwise.
By default, the customer doesn't receive any email notification.
sendIpn
boolean
Possible values are true or false.
If true, it sends IPN/webhook notification: IPN_TYPE_ID=10,
IPN_TYPE_NAME=SubscriptionTerminated.
By default, no IPN/webhook notification is sent.
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
{
  "subscriptionIds": [
    1111111,
    1111111
  ],
  "sendVendorEmail": true,
  "sendCustomerEmail": true,
  "sendIpn": true,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "message": "Bulk Terminate Subscriptions request accepted and scheduled for processing.",
  "request": {
    "subscriptionIds": [
      1111111,
      1111111
    ],
    "sendVendorEmail": true,
    "sendCustomerEmail": true,
    "sendIpn": true,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}