Delete an additional field
Overview
Use the deleteSubscriptionAdditionalInformationField method to delete the additional information field from a subscription.
Parameters
Parameters | Type/Description |
---|---|
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. |
Response
Parameters | Type/Description |
---|---|
Boolean | Object |
|
true or false depending on whether the additional information field was successfully deleted or not. |
Request
<?php require('PATH_TO_AUTH'); $subscriptionReference = '351D8F557E'; $fieldName = 'subscription'; $fieldValue = 'test'; $jsonRpcRequest = array ( 'method' => 'deleteSubscriptionAdditionalInformationField', 'params' => array($sessionID, $subscriptionReference, $fieldName), 'id' => $i++, 'jsonrpc' => '2.0'); var_dump (callRPC((Object)$jsonRpcRequest, $host, true));