Skip to main content

Apply Discount

Apply the discount to the existing subscription.

Post
https://store.payproglobal.com/api/Subscriptions/ApplyDiscount
Request Parametersapplication/json
ApplyDiscountRequestModel
object
discountValue
number
required
The value of the discount you want to apply.
isPercentage
boolean
optional
Possible values are true or false.
If true, the discount value is considered as a percentage one.
If false, the discount is a fixed value.
applyDiscountForAllFuturePayments
boolean
optional
Possible values are true or false.
If true, the discount will be applied to all future recurring charges.
If false, the discount will be applied only to one upcoming subscription payment.
applyDiscountForXFuturePayments
number
The number of billing cycles for which the discount should be applied.
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
ApplyDiscountResponseModel
object
isDiscountApplied
boolean
Possible values are true or false. If true, the discount has been successfully applied; if false, otherwise.
request
object
discountValue
number
The value of the discount you want to apply.
isPercentage
boolean
Possible values are true or false.
If true, the discount value is considered as a percentage one.
If false, the discount is a fixed value.
applyDiscountForAllFuturePayments
boolean
Possible values are true or false.
If true, the discount will be applied to all future recurring charges.
If false, the discount will be applied only to one upcoming subscription payment.
applyDiscountForXFuturePayments
number
The number of billing cycles for which the discount should be applied.
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
{
  "discountValue": 10.0,
  "isPercentage": true,
  "applyDiscountForAllFuturePayments": true,
  "applyDiscountForXFuturePayments": 3,
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "isDiscountApplied": true,
  "request": {
    "discountValue": 1.0,
    "isPercentage": true,
    "applyDiscountForAllFuturePayments": true,
    "applyDiscountForXFuturePayments": 3,
    "subscriptionId": 954874,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": false
}