Change Name

Update the subscription name.

Post

https://store.payproglobal.com/api/Subscriptions/ChangeName

Request Parametersapplication/json

UpdateNameRequestModel

object

newSubscriptionName

string

required

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

UpdateNameResponseModel

object

request

object

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

{
  "newSubscriptionName": "Monthly premium subscription plan",
  "sendCustomerNotification": true,
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}

Response Sample

{
  "request": {
    "newSubscriptionName": "Monthly premium subscription plan",
    "sendCustomerNotification": true,
    "subscriptionId": 1111111,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}