Assign an additional information field to a subscription
Last updated: 25-Sep-2019
Use the addSubscriptionAdditionalInformationField method to assign an additional information field to a subscription.
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 | Type/Description |
---|---|
sessionID |
Required (string) |
|
Session identifier, the output of the Login method. Include sessionID into all your requests. Avangate 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. |
Parameters | Type/Description |
---|---|
AdditionalSubscriptionInformation | Object |
|
Contains information related to the additional information field. |
<?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));
Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.
We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.