Skip to main content

Change Billing Period

Update the subscription billing cycle.

Post
https://store.payproglobal.com/api/Subscriptions/ChangeBillingPeriod
Request Parametersapplication/json
UpdateBillingCyclePeriodRequestModel
object
newBillingPeriodTypeId
integer
required
The new subscription billing period type you want to apply. The available type IDs: 1 - Days, 2 - Weeks, 3 - Months, 4 - Years.
newBillingPeriodValue
integer
required
The new subscription billing period value that is updated according to the subscription's billing period type. It specifies each N days/weeks/months/years when the subscription charge will happen.
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 tab.
Response Parametersapplication/json
UpdateBillingCyclePeriodResponseModel
object
request
object
newBillingPeriodTypeId
integer
The new subscription billing period type you want to apply. The available type IDs: 1 - Days, 2 - Weeks, 3 - Months, 4 - Years.
newBillingPeriodValue
integer
The new subscription billing period value that is updated according to the subscription's billing period type. It specifies each N days/weeks/months/years when the subscription charge will happen.
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 tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
  "newBillingPeriodTypeId": 3,
  "newBillingPeriodValue": 2,
  "newSubscriptionName": "Monthly premium subscription plan",
  "sendCustomerNotification": true,
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "request": {
    "newBillingPeriodTypeId": 3,
    "newBillingPeriodValue": 2,
    "newSubscriptionName": "Monthly premium subscription plan",
    "sendCustomerNotification": true,
    "subscriptionId": 1111111,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}