For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update customer

Use the updateCustomerInformation method to update the details of a customer entity from the 2Checkout system.

Request 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.

Required (object)

Use this object to update customer information.

UpdateEndUserSubscriptions

Optional (boolean)

You can push the changes made on the customer info to the end-user details for all subscriptions belonging to this customer. Set true to have the changes reflected on the end-user details for all subscriptions. If null or false, the changes are made only at the customer level. Default value is false.

Request sample

<?php

require ('PATH_TO_AUTH');

$customerReference = CUSTOMER_REFERENCE;
$externalCustomerReference = 'EXTERNAL_CUSTOMER_REFERENCE'; // Optional, but if you include it it needs to belong to the same customer as the internal Avangate customer reference

// Get customer info
$jsonRpcRequest = array(
    'method' => 'getCustomerInformation',
    'params' => array($sessionID, $customerReference, $externalCustomerReference),
    'id' => $i++,
    'jsonrpc' => '2.0'
);

$existingCustomer = callRPC((Object)$jsonRpcRequest, $host, true);

// Update email
$existingCustomer->Email = 'newemailaddress@email.com';

// New Credit object (optional)
$existingCustomer->Credit = new stdClass();
$existingCustomer->Credit->Limit = 51.0;       // float
$existingCustomer->Credit->Remaining = 21.0;   // float
$existingCustomer->Credit->Currency = 'EUR';   // string

$UpdateEndUserSubscriptions = false; // Optional, but if true the changes made on customer info are pushed to all subscriptions from this customer.

// Send updated customer info
$jsonRpcRequest = array(
    'method' => 'updateCustomerInformation',
    'params' => array($sessionID, $existingCustomer, $UpdateEndUserSubscriptions),
    'id' => $i++,
    'jsonrpc' => '2.0'
);

var_dump(callRPC((Object)$jsonRpcRequest, $host, true));

Response parameters

Type
Description

Boolean

true or false depending on whether or not the operation succeeded.

Last updated

Was this helpful?