Skip to main content
Aria Knowledge Central

add_rate_schedule_on_plan_m

Summary

API Name add_rate_schedule_on_plan_m
Class administration_services_m
Update Version 16

Description

Create a new rate schedule and add it to an existing plan.

Inputs

Name Type Length Required Description
client_no long 12 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key string 32 Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

plan_no long   Yes

Plan number that rate schedule will be added to.

Alternative required field: client_plan_id

client_plan_id string 100 Yes

Client defined unique identifier

Alternative required field: plan_no

schedule_name string 100 Yes

Name for the schedules to be created. REST input arrays should passed in the following format: schedule[0][schedule_name]=firstSchedule&schedule[1][schedule_name]= secondSchedule etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on. Translatable.

currency_cd string 3 Yes

Currency for the schedules to be created. REST input arrays should passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=gbp

client_rate_schedule_id string 100 No

Client defined unique id

is_default int 1 Yes

This flag denotes if this rate schedule is the default one for this plan. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule denoting it is the default. For subsequent rate schedules, the default is set to 0.

recurring_billing_interval int 100 No

If a null/no value is provided then recurring_billing_interval should default to 1, i.e., monthly interval.Recurring Billing Interval [ can be either of 1, 3, 6 or 12, ) 1 – Monthly, 3 – Quarterly, 6 - Semi-Annually, 12 – Annually, Custom -

usage_billing_interval int 100 No

If null/no value is provided then usage_billing_interval should default to 1, i.e., monthly interval.Usage Billing Interval [ can be either of 1, 3, 6 or 12, ) 1 – Monthly, 3 – Quarterly, 6 - Semi-Annually, 12 – Annually, Custom -

recurring_billing_period_type int 100 No

If a null/no value is provided then recurring_billing_period_type should default to 3, i.e., monthly period type. Recurring Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly

usage_billing_period_type int 100 No

If a null/no value is provided then usage_billing_period_type should default to 3, i.e., monthly period type. Usage Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly

available_from_dt string 10 No

Date from which the rate schedule will be available for the assignment. The date format must be yyyy-mm-dd

available_to_dt string 10 No

Date after which the rate schedule will not be available for the assignment. The date format must be yyyy-mm-dd

future_rate boolean 1 No

Indicator whether future rates should be supported or not

future_change_dt string 10 No

Date after which the future rates should be assigned. The date format must be yyyy-mm-dd

followup_rs_no long 100 No

Aria internal id of follow-up default rate schedule

Alternative field: client_followup_rs_id

client_followup_rs_id string 100 No

Client defined id of followup rate schedule. One of the values, i.e., either followup_rs_no or client_followup_rs_id should be provided if a followup rate schedule information should be provided.

Alternative field: followup_rs_no

service object   No

The service associated with this method.

See fields below

service.tier fields

Name Type Length Required Description
from int 10 No

Tiered Pricing Rule that specifies from units at schedule level. This will override the rate tier's from units at service level. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][from]=1&service[0][tier][0] [schedule][1][from]=1 etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on.

to int 10 No

Tiered Pricing Rule that specifies to units at schedule level. This will override the rate tier's to units at service level. To indicate no upper limit, value should be left blank. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][to]=3&service[0][tier][0][schedule][1][to]=7 etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on.

description string 50 No

This field is used to display custom rate tier description. This will override the rate tier's description at service level. REST input arrays should be passed in the following format: service[0][tier][0][description]=Custom description &service[0][tier][0][description]=custom description etc. Index [tier][0] specifies the first tier of the rate schedule and [tier][1] specifies the second tier of the schedule and so on.

amount float 11 Yes

Tiered Pricing Rule that specifies rate per unit.REST input arrays should be passed in the following format: service[0][tier][0][amount]=3&service[0][tier][1][amount]=4 etc where [tier][0][amount] specifies price from first tier and [tier][1][amount] specifies price for second schedule and so on.

future_amount float 11 No

Future Rate Per Unit for the tier. future_amount should be specified only if future_rate=1 and future_change_dt is specified. REST input arrays should be passed in the following format: service[0][tier][0][future_amount]=3&service[0][tier][0][schedule][1] [future_amount]=4 etc

service fields

Name Type Length Required Description
service_no long   No  

Alternative field: client_service_id

client_service_id string 100 No

Client defined unique id

Alternative field: service_no

tier object   No

The tier associated with this method.

See fields below

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error

error_msg string   No

Textual description of any error that occurred. "OK" if there was no error.

rate_schedule object   No

The rate_schedule associated with this method.

See fields below

rate_schedule fields

Name Type Length Required Description
schedule_no long   Yes

Specifies the schedule number whose details is going to be edited. This can be nullable for new services.REST input arrays should passed in the following format: schedule[0][schedule_no]=1212121&schedule[1][schedule_no]=4234232 etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on

client_rate_schedule_id string   No

Client defined unique id

TOP
  • Was this article helpful?