Skip to main content

Change Custom Fields

Update the subscription custom fields.

Request Parametersapplication/json
UpdateCustomFieldsRequestModel
object
customFields
dictionary<string,string>
The new custom field value that needs to be updated in the subscription.
It is a dictionary of string [key] and string [value].
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
UpdateCustomFieldsResponseModel
object
request
object
customFields
dictionary<string,string>
The new custom field value that needs to be updated in the subscription.
It is a dictionary of string [key] and string [value].
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
{
"customFields": {
"some-key-1": "your custom value 1",
"some-key-2": "your custom value 2"
},
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"customFields": {
"some-key-1": "your custom value 1",
"some-key-2": "your custom value 2"
},
"subscriptionId": 954874,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
},
"errors": [
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
},
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
}
],
"isSuccess": false
}