Skip to main content

Bulk Change Recurring Price

Update the recurring price for the subscriptions.

Post
https://store.payproglobal.com/api/Subscriptions/BulkChangeRecurringPrice
Request Parametersapplication/json
UpdateSubscriptionsRequestModel
object
productId
integer
required
The product ID of the subscriptions for which you want to update the price.
newPriceValue
number
required
The new subscription recurring price that you want to apply.
priceCurrencyCode
string
required
The subscription currency code. List of supported currency codes at PayPro Global.
If updateReferencePrice is set to true, this currency is used as the reference currency
when updating the subscription’s reference price.
quantity
integer
optional
The new product quantity that you want to apply.
By default, it returns the current product quantity.
subscriptionStatusId
integer
optional
Specifies the subscription status used to filter the subscriptions to be updated.
Supported values are 1 (Active) and 2 (Suspended).
If this parameter is not specified, only Active subscriptions are updated.
updateReferencePrice
boolean
optional
Possible values are true or false.
Determines whether to update the subscription’s reference price
and reference currency for the product specified in productId.
If set to true, the subscription’s reference price is updated
and its reference currency is changed to the currency specified in priceCurrencyCode.
If set to false, only subscriptions whose billing currency matches the currency specified
in priceCurrencyCode are updated.
Future charges are recalculated based on the new reference price,
while the customer continues to be billed in their subscription currency
using the exchange rate applicable at the time of renewal.
newSubscriptionName
string
optional
The new name for a subscription that you want to apply.
sendCustomerNotification
boolean
optional
Possible values are true or false.
If true, it sends a customer an email that informs about
the changed subscription details, false otherwise.
By default, the customer doesn't receive any email notification.
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
UpdateSubscriptionsResponseModel
object
changedItems
array[object]
itemId
integer
The subscription ID that has been updated.
isActionSuccess
boolean
Possible values are true or false. If true, the action was successful; if false, otherwise.
actionItemMessage
string
It displays the action message.
request
object
productId
integer
The product ID of the subscriptions for which you want to update the price.
newPriceValue
number
The new subscription recurring price that you want to apply.
priceCurrencyCode
string
The subscription currency code. List of supported currency codes at PayPro Global.
If updateReferencePrice is set to true, this currency is used as the reference currency
when updating the subscription’s reference price.
quantity
integer
The new product quantity that you want to apply.
By default, it returns the current product quantity.
subscriptionStatusId
integer
Specifies the subscription status used to filter the subscriptions to be updated.
Supported values are 1 (Active) and 2 (Suspended).
If this parameter is not specified, only Active subscriptions are updated.
updateReferencePrice
boolean
Possible values are true or false.
Determines whether to update the subscription’s reference price
and reference currency for the product specified in productId.
If set to true, the subscription’s reference price is updated
and its reference currency is changed to the currency specified in priceCurrencyCode.
If set to false, only subscriptions whose billing currency matches the currency specified
in priceCurrencyCode are updated.
Future charges are recalculated based on the new reference price,
while the customer continues to be billed in their subscription currency
using the exchange rate applicable at the time of renewal.
newSubscriptionName
string
The new name for a subscription that you want to apply.
sendCustomerNotification
boolean
Possible values are true or false.
If true, it sends a customer an email that informs about
the changed subscription details, false otherwise.
By default, the customer doesn't receive any email notification.
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
{
  "productId": 12345,
  "newPriceValue": 50.00,
  "priceCurrencyCode": "USD",
  "quantity": 1,
  "subscriptionStatusId": 2,
  "updateReferencePrice": true,
  "newSubscriptionName": "Monthly premium subscription plan",
  "sendCustomerNotification": true,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "changedItems": [{
    "itemId": 87654321,
    "isActionSuccess": true,
    "actionItemMessage": "Changed price"
  },{
    "itemId": 87654321,
    "isActionSuccess": true,
    "actionItemMessage": "Changed price"
  },{
    "itemId": 87654321,
    "isActionSuccess": true,
    "actionItemMessage": "Changed price"
  }],
  "request": {
    "productId": 12345,
    "newPriceValue": 50.00,
    "priceCurrencyCode": "USD",
    "quantity": 1,
    "subscriptionStatusId": 2,
    "updateReferencePrice": true,
    "newSubscriptionName": "Monthly premium subscription plan",
    "sendCustomerNotification": true,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}