Update a subscription plan/product
Last updated: 25-Sep-2019
Rate this article:
Overview
Use the updateProduct method to update the configuration of a subscription plan/product you already configured for your account.
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 configure your subscription plans/products.
You can update/edit all parameters, except the following:
|
Exceptions
When updating a subscription plan/product, you also update its PricingConfigurations. However, you cannot modify:
- The pricing configuration CODE.
- The PricingSchema from DYNAMIC to FLAT or vice versa.
Request
<?php
require ('PATH_TO_AUTH');
$ProductCode = 'NewProdCodeAPI12345';
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getProductByCode',
'params' => array($sessionID, $ProductCode)
);
$myProduct = callRPC($jsonRpcRequest, $host);
$myProduct->ProductName = 'Edited_From_API_Again';
var_dump ($myProduct);
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'updateProduct',
'params' => array($sessionID, $myProduct)
);
$updatedProduct = callRPC($jsonRpcRequest, $host);
var_dump ($updatedProduct);
?>
Response
bool(true)
Rate this article:
