JSON API » plans » plans/update

Updates an existing rate plan.

Input parameters

Requires authentication and the commerce role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of rate plan to update.	Yes
auto_topup	Decimal	The balance to top up to when doing an automatic topup.	No	Current value.
bill_defer	Integer	1 to defer billing of features until start of next billing period, 0 not to.	No	Current value.
bill_type	String	Billing type. "external", "none", "prepaid", "prepaid_invoices", "prepaid_calls", or "postpaid".	No	Current value.
bulk_calls	Integer	Maximum concurrent bulk dialler calls. -1 for default limit.	No	Current value.
call_maximum	Decimal	Maximum spending on calls per customer per day. -1 for no limit.	No	Current value.
callerid_in_external	Integer	1 to pass callerid from inbound external calls to telephone lines, 0 not to.	No	Current value.
carry_forward_messages	Integer	1 to carry forward unused messages for one billing period, 0 not to.	No	Current value.
carry_forward_seconds	Integer	1 to carry forward unused call seconds for one billing period, 0 not to.	No	Current value.
conference_calls	Integer	Maximum concurrent conference calls. -1 for no limit.	No	Current value.
contract	String	Minimum contract length. "1_month", "3_month", "6_month", "1_year", "18_month", "2_year", "3_year", or empty string for none.	No	Current value.
cos_timegroup	Integer	ID of time group for class of service. 0 for none.	No	Current value.
currency	String	Currency costs are in.	No	Current value.
description	String	Description.	No	Current value.
dialplan	String	Dial plan for the rate plan. Empty string for default.	No	Current value.
external_out	Integer	1 to allow external calls by default, 0 not to.	No	Current value.
huntgroup_dests	Integer	Maximum destinations per hunt group. -1 for no limit.	No	Current value.
included_messages	Integer	Number of messages included free each billing period.	No	Current value.
included_seconds	Integer	Number of calls seconds included free each billing period.	No	Current value.
inconnect_margin	Decimal	Profit margin to add to inbound connect fee after markup.	No	Current value.
inconnect_markup	Integer	Percentage markup on inbound connect fee.	No	Current value.
incost_margin	Decimal	Profit margin to add to inbound per-minute cost after markup.	No	Current value.
incost_markup	Integer	Percentage markup on inbound per-minute cost.	No	Current value.
inheritable	Integer	1 to allow resellers to inherit their plans from this plan, 0 not to.	No	Current value.
inmaximum	Integer	Maximum concurrent inbound calls. -1 for no limit.	No	Current value.
inmessage_margin	Decimal	Profit margin to add to inbound messages after markup.	No	Current value.
inmessage_markup	Integer	Percentage markup on inbound messages.	No	Current value.
internal_out	Integer	1 to allow internal calls by default, 0 not to.	No	Current value.
invoices	String	Whether to send invoices. "customer", "parent", "queue", or empty string for no invoices.	No	Current value.
invoices_due	Integer	The number of days after issue that invoices become due. 0 for immediate. -1 for manual.	No	Current value.
invoices_overdue	Integer	The number of days after invoices become due that they become overdue. -1 for manual.	No	Current value.
invoice_detail	String	What detail to include on invoices. "summary", "transactions", "cdrs", "direction_cdrs", "group_cdrs", "source_cdrs", "transactions_cdrs", "transactions_direction_cdrs", "transactions_group_cdrs", or "transactions_source_cdrs".	No	Current value.
invoice_format	String	Format invoices are sent in. "pdf" or "xml".	No	Current value.
low_balance	Decimal	The balance to trigger an automatic topup at.	No	Current value.
name	String	Name,	No	Current value.
maxmsg	Integer	Maximum messages per mailbox.	No	Current value.
outconnect_margin	Decimal	Profit margin to add to outbound connect fee after markup.	No	Current value.
outconnect_markup	Integer	Percentage markup on outbound connect fee.	No	Current value.
outcost_margin	Decimal	Profit margin to add to outbound per-minute cost after markup.	No	Current value.
outcost_markup	Integer	Percentage markup on outbound per-minute cost.	No	Current value.
outmaximum	Integer	Maximum concurrent outbound calls. -1 for no limit.	No	Current value.
outmessage_margin	Decimal	Profit margin to add to outbound messages after markup.	No	Current value.
outmessage_markup	Integer	Percentage markup on outbound messages.	No	Current value.
overmax	Integer	1 to allow customers to go over maximum calls, 0 to reject calls.	No	Current value.
pagegroup_dests	Integer	Maximum destinations per page group. -1 for no limit.	No	Current value.
parent	Integer	ID the plan inherits settings from. 0 for no parent.	No	Current value.
payment_type	String	Payment type on signup. "creditcard", "direct_debit", "external", or "none".	No	Current value.
peer1	Integer	ID of peer to send all outbound calls to. 0 to use routing exceptions.	No	Current value.
period	String	Billing period. "daily", "weekly", "monthly", "2_monthly", "3_monthly", "6_monthly", "annually", or empty string for indefinite.	No	Current value.
period_start	String	When the billing period starts. "start" or "exact".	No	Current value.
person_role	Integer	Id of the first person's role on signup.	No	Current value.
purge_messages	String	When to purge mailbox messages. "1_day", "1_week", "1_month", "3_months", "6_months", "1_year", or empty string for never.	No	Current value.
queue_calls	Integer	Maximum concurrent queue calls. -1 for no limit.	No	Current value.
queue_dests	Integer	Maximum destinations per queue. -1 for no limit.	No	Current value.
record_maximum	Integer	Maximum number of seconds of recordings to keep. -1 for unlimited.	No	Current value.
require_tax_number	Integer	1 to require tax number in signup, 0 not to.	No	Current value.
rounding	Integer	Number of digits to round call prices to.	No	Current value.
service_call_locked	Integer	1 to forward calls to customer service if customer is locked, 0 not to.	No	Current value.
service_copy	Integer	1 to copy customer service on emails to customers, 0 not to.	No	Current value.
service_email	String	Customer service email address. Empty string for none.	No	Current value.
service_telephone	String	Customer service telephone number. Empty string for none.	No	Current value.
signup_topup	Integer	1 to attempt to topup the customer's account on signup. 0 not to.	No	Current value.
shared	Integer	Whether the plan is shared. "resellers", "resellers_recursive", or empty string not to share.	No	Current value.
totalmaximum	Integer	Maximum concurrent total calls. -1 for no limit.	No	Current value.
use_markups	Integer	1 to use markups, 0 to reject calls if this plan has no matching cost exception.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The rate plan does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/plans/update/?auth_username=user;auth_password=password;id=123;name=example

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.14	inconnect, incost, inmessage, outconnect, outcost, and outmessage input parameters renamed to inconnect_markup, incost_markup, inmessage_markup, outconnect_markup, outcost_markup, and outmessage_markup. bulk_calls, conference_calls, huntgroup_dests, inconnect_margin, incost_margin, inmessage_margin, outconnect_margin, outcost_margin, outmessage_margin, pagegroup_dests, queue_calls, and queue_dests input parameters added.
3.13	Function added.