Skip to main content

Change Next Payment Date

Update the due date of the upcoming subscription charge.

Post
https://store.payproglobal.com/api/Subscriptions/ChangeNextPaymentDate
Request Parametersapplication/json
UpdateNextPaymentRequestModel
object
newNextPaymentDate
string<date-time>
required
The new subscription next charge date you want to apply.
shiftPaymentSchedule
boolean
optional
Possible values are true or false.
If true, it shifts all next subscription payments according to the updated
next payment date. If false, it changes only the upcoming payment date
without shifting all further subscription charge dates.
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.
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
UpdateNextPaymentResponseModel
object
request
object
newNextPaymentDate
string<date-time>
The new subscription next charge date you want to apply.
shiftPaymentSchedule
boolean
Possible values are true or false.
If true, it shifts all next subscription payments according to the updated
next payment date. If false, it changes only the upcoming payment date
without shifting all further subscription charge dates.
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.
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
{
  "newNextPaymentDate": "2023-12-29T12:23:33.8958684-05:00",
  "shiftPaymentSchedule": true,
  "newSubscriptionName": "Monthly premium subscription plan",
  "sendCustomerNotification": true,
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "request": {
    "newNextPaymentDate": "2023-12-29T12:23:33.8958684-05:00",
    "shiftPaymentSchedule": true,
    "newSubscriptionName": "Monthly premium subscription plan plus 5 extra packages",
    "sendCustomerNotification": true,
    "subscriptionId": 1111111,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}