get_plans_by_promo_code_m Sample Call and Response
This example retrieves a summary list of plans associated with a promotion code, based on the get_plans_by_promo_code_m method defined in plsql_m_r73.yml. Unlike get_plans_by_promo_code_all_m, this method returns only the plans' own configuration fields; it does not return each plan's associated services or non-subscription offering details.
This example requests translated plan names and descriptions for two representative plans on the promotion code and does not show every optional field this method can return.
Sample call
{
"rest_call": "get_plans_by_promo_code_m",
"output_format": "json",
"client_no": 100848,
"auth_key": "8cfb51c1c9110f4152c",
"promo_code": "SUMMER2026",
"include_translations": "true"
}
The promo_code field is required for this method and identifies the promotion for which to list associated plans. Setting include_translations to true requests each plan's translated name and description in the locales configured for the client. This example omits the include_rs_summary field entirely, since it is marked usage: unused for this method in the yml and the system does not act on it.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"plan_details": [
{
"plan_no": 40021,
"plan_name": "Premium Streaming Monthly",
"plan_desc": "Full-catalog streaming plan billed monthly",
"supp_plan_ind": 0,
"billing_ind": 1,
"display_ind": 1,
"rollover_months": 12,
"rollover_plan_no": 40030,
"early_cancel_fee": 25.00,
"early_cancel_min_months": 3,
"suspension_period": 30,
"new_acct_status": 1,
"rollover_acct_status": 1,
"rollover_acct_status_days": 0,
"init_free_months": 1,
"plan_2_assign_on_susp": 40099,
"default_notify_method": 10,
"prepaid_ind": 0,
"currency_cd": "usd",
"client_plan_id": "PLAN-PREM-MTH",
"client_rollover_plan_id": "PLAN-PREM-ANNUAL",
"client_plan_id_2_assign_on_susp": "PLAN-SUSPENDED",
"proration_invoice_timing_cd": "I",
"plan_translation_info": [
{
"plan_no": 40021,
"locale_name": "fr_FR",
"plan_name": "Diffusion Premium Mensuelle",
"plan_desc": "Formule de diffusion en continu, catalogue complet, facturation mensuelle",
"locale_no": 12
}
]
},
{
"plan_no": 40022,
"plan_name": "Premium Streaming Annual",
"plan_desc": "Full-catalog streaming plan billed annually",
"supp_plan_ind": 0,
"billing_ind": 1,
"display_ind": 1,
"new_acct_status": 1,
"default_notify_method": 10,
"prepaid_ind": 0,
"currency_cd": "usd",
"client_plan_id": "PLAN-PREM-ANNUAL",
"proration_invoice_timing_cd": "I"
}
]
}
An error_code of zero and an error_msg of "OK" indicate the request completed successfully. The supp_plan_ind value of 0 means each plan is a master plan rather than a supplemental plan; new_acct_status value of 1 means ACTIVE and default_notify_method value of 10 means PDF delivered by email, each with several other allowable values documented in the method's own field reference. The plan_details array holds one entry per plan on the promotion code; this example shows two, with the second one abbreviated, but a real promotion code could return more. This example omits the rollover_plan_duration, rollover_plan_uom_cd, init_free_period_duration, init_free_period_uom_cd, initial_plan_status_cd, rollover_plan_status_duration, rollover_plan_status_uom_cd, and rollover_plan_status_cd fields, along with the contract_rollover_plan_no, contract_rollover_client_plan_id, and contract_rollover_rate_sched fields, since they add contract rollover detail beyond a basic summary lookup. It also omits nso_incl_list_scope, since that field is marked nonpublic for this method, and error_details, since that field is marked nonpublic in the shared definitions. The plan_rate_schedules_details field is left out entirely, since it is marked usage: unused for this method.