Update an additional field
Use the updateSubscriptionAdditionalInformationField method to update the additional information field for a subscription.
Requirements
The maximum field length is 100 characters.
Request parameters
sessionID
Required (string)
Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
SubscriptionReference
Required (string)
Unique, system-generated subscription identifier.
fieldName
Required (string)
The name of the additional information field. Used for identifying additional information fields.
fieldValue
Optional (string)
The value you assign to the additional information field.
Request sample
<?php
require('PATH_TO_AUTH');
$subscriptionReference = '351D8F557E';
$fieldName = 'subscription';
$fieldValue = 'test2';
$jsonRpcRequest = array (
'method' => 'updateSubscriptionAdditionalInformationField',
'params' => array($sessionID, $subscriptionReference, $fieldName, $fieldValue),
'id' => $i++,
'jsonrpc' => '2.0'
);
var_dump(callRPC((Object)$jsonRpcRequest, $host, true));Response parameters
AdditionalSubscriptionInformation
Object
Contains information related to the additional information field.
fieldName
String
The name of the additional information field. Used for identifying additional information fields.
fieldValue
String
The value of the additional information field.
Last updated
Was this helpful?