Assign additional field
Overview
Use the addSubscriptionAdditionalInformationField method to assign an additional information field to a subscription.
Requirements
The maximum number of additional information fields that can be added on a subscription is 5, while the maximum field length is 100 characters.
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. |
|
|
fieldValue |
Required (string) |
|
|
The value of the additional information field. |
Response
| Parameters | Type/Description |
|---|---|
| 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. |
Request
<?php
require('PATH_TO_AUTH');
$subscriptionReference = '351D4F557E';
$fieldName = 'subscription';
$fieldValue = 'test';
$jsonRpcRequest = array (
'method' => 'addSubscriptionAdditionalInformationField',
'params' => array($sessionID, $subscriptionReference, $fieldName, $fieldValue),
'id' => $i++,
'jsonrpc' => '2.0');
var_dump (callRPC((Object)$jsonRpcRequest, $host, true));
