Promo Code List
Lists your institute's promo codes of one type, newest first, one page at a time, with the courses each one applies to and whether it has been used. Use it to show or audit the discount codes you have running.
GET
/promocodePromo Code List
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/promocode?organization_id=<organizationId>&promotype=1&page=1&per_page=<per_page>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"promo_codes": [
{
"promo_code_id": 101,
"promo_code_type": "promo_code_discount",
"promo_code_text": "CODE20",
"discount": 20,
"max_discount_amount": 1000,
"promo_code_description": "20% off",
"promo_code_creation_time": 1662110566,
"promo_code_start_time": "02 Aug 2019",
"promo_code_end_time": "10 Sep 2022",
"promo_code_used": 0,
"usd_discount": 20,
"max_usd_discount_amount": 0,
"packages": "1369,10185"
},
{
"promo_code_id": 104,
"promo_code_type": "promo_code_discount",
"promo_code_text": "Promo",
"discount": 20,
"max_discount_amount": 20,
"promo_code_description": "hello bhai, How are you ?\nsab mast bhai",
"promo_code_creation_time": 1629718793,
"promo_code_start_time": "09 Aug 2021",
"promo_code_end_time": "17 Aug 2021",
"promo_code_used": 0,
"usd_discount": 20,
"max_usd_discount_amount": 0,
"packages": "1369,1370,12542"
},
{
"promo_code_id": 135,
"promo_code_type": "promo_code_discount",
"promo_code_text": "DIS",
"discount": 25,
"max_discount_amount": 200,
"promo_code_description": "Discount",
"promo_code_creation_time": 1566306759,
"promo_code_start_time": "20 Aug 2019",
"promo_code_end_time": "13 Aug 2020",
"promo_code_used": 0,
"usd_discount": 25,
"max_usd_discount_amount": 0,
"packages": "1369,1370,1371,1402"
},
{
"promo_code_id": 270,
"promo_code_type": "promo_code_discount",
"promo_code_text": "cgvhbjnk",
"discount": 50,
"max_discount_amount": 100,
"promo_code_description": "gvhbjnkm",
"promo_code_creation_time": 1570425496,
"promo_code_start_time": "07 Oct 2019",
"promo_code_end_time": "07 Oct 2019",
"promo_code_used": 0,
"usd_discount": 50,
"max_usd_discount_amount": 0,
"packages": "1369"
},
{
"promo_code_id": 274,
"promo_code_type": "promo_code_discount",
"promo_code_text": "100",
"discount": 10,
"max_discount_amount": 100,
"promo_code_description": "xcx",
"promo_code_creation_time": 1572425964,
"promo_code_start_time": "30 Oct 2019",
"promo_code_end_time": "01 Nov 2019",
"promo_code_used": 0,
"usd_discount": 10,
"max_usd_discount_amount": 0,
"packages": "1369"
},
{
"promo_code_id": 316,
"promo_code_type": "promo_code_discount",
"promo_code_text": "new",
"discount": 10,
"max_discount_amount": 100,
"promo_code_description": "e",
"promo_code_creation_time": 1575448510,
"promo_code_start_time": "04 Dec 2019",
"promo_code_end_time": "06 Dec 2019",
"promo_code_used": 0,
"usd_discount": 10,
"max_usd_discount_amount": 0,
"packages": "1616,1371"
},
{
"promo_code_id": 318,
"promo_code_type": "promo_code_discount",
"promo_code_text": "sel1000",
"discount": 100,
"max_discount_amount": 4000,
"promo_code_description": "coupon\n",
"promo_code_creation_time": 1575449345,
"promo_code_start_time": "02 Dec 2019",
"promo_code_end_time": "14 Dec 2019",
"promo_code_used": 0,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "1369,1371,1444"
},
{
"promo_code_id": 1848,
"promo_code_type": "promo_code_discount",
"promo_code_text": "Web100",
"discount": 100,
"max_discount_amount": 50000,
"promo_code_description": "test",
"promo_code_creation_time": 1649316136,
"promo_code_start_time": "02 Jan 2020",
"promo_code_end_time": "20 Jul 2022",
"promo_code_used": 0,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "1370,1371,10185"
},
{
"promo_code_id": 12943,
"promo_code_type": "promo_code_discount",
"promo_code_text": "VINGYAN",
"discount": 100,
"max_discount_amount": 1000,
"promo_code_description": "100",
"promo_code_creation_time": 1582610581,
"promo_code_start_time": "24 Feb 2020",
"promo_code_end_time": "26 Feb 2020",
"promo_code_used": 1,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "2023"
},
{
"promo_code_id": 12952,
"promo_code_type": "promo_code_discount",
"promo_code_text": "HOLI100",
"discount": 100,
"max_discount_amount": 10000,
"promo_code_description": "100%",
"promo_code_creation_time": 1584175786,
"promo_code_start_time": "11 Mar 2020",
"promo_code_end_time": "31 Mar 2020",
"promo_code_used": 1,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "2075"
},
{
"promo_code_id": 12976,
"promo_code_type": "promo_code_discount",
"promo_code_text": "IELTS",
"discount": 100,
"max_discount_amount": 10000,
"promo_code_description": "IELTS",
"promo_code_creation_time": 1585309148,
"promo_code_start_time": "26 Mar 2020",
"promo_code_end_time": "31 Mar 2020",
"promo_code_used": 1,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "2257"
},
{
"promo_code_id": 13121,
"promo_code_type": "promo_code_discount",
"promo_code_text": "FLAT100",
"discount": 100,
"max_discount_amount": 50000,
"promo_code_description": "100% discount ",
"promo_code_creation_time": 1644402486,
"promo_code_start_time": "15 Apr 2020",
"promo_code_end_time": "28 Feb 2022",
"promo_code_used": 1,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "1396,1429,2229,2855,2858,2869,3130,3166,3182"
},
{
"promo_code_id": 13123,
"promo_code_type": "promo_code_discount",
"promo_code_text": "UGADI",
"discount": 50,
"max_discount_amount": 30000,
"promo_code_description": "UGADI",
"promo_code_creation_time": 1587104056,
"promo_code_start_time": "12 Apr 2020",
"promo_code_end_time": "18 Apr 2020",
"promo_code_used": 0,
"usd_discount": 50,
"max_usd_discount_amount": 0,
"packages": "2627"
},
{
"promo_code_id": 13452,
"promo_code_type": "promo_code_discount",
"promo_code_text": "promo8jul",
"discount": 10,
"max_discount_amount": 100,
"promo_code_description": "promo8jul",
"promo_code_creation_time": 1594200900,
"promo_code_start_time": "08 Jul 2020",
"promo_code_end_time": "30 Jul 2020",
"promo_code_used": 0,
"usd_discount": 10,
"max_usd_discount_amount": 0,
"packages": "1370"
},
{
"promo_code_id": 18415,
"promo_code_type": "promo_code_discount",
"promo_code_text": "hello",
"discount": 100,
"max_discount_amount": 14000,
"promo_code_description": "lut lo",
"promo_code_creation_time": 1623064492,
"promo_code_start_time": "02 Jun 2021",
"promo_code_end_time": "09 Jun 2021",
"promo_code_used": 0,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "10185,1369"
},
{
"promo_code_id": 18572,
"promo_code_type": "promo_code_discount",
"promo_code_text": "edmingleabhi",
"discount": 20,
"max_discount_amount": 1000,
"promo_code_description": "Independence month offer use it before ends",
"promo_code_creation_time": 1629975614,
"promo_code_start_time": "01 Aug 2021",
"promo_code_end_time": "31 Aug 2021",
"promo_code_used": 0,
"usd_discount": 20,
"max_usd_discount_amount": 0,
"packages": "1369,2229"
},
{
"promo_code_id": 18720,
"promo_code_type": "promo_code_discount",
"promo_code_text": "Get",
"discount": 100,
"max_discount_amount": 1,
"promo_code_description": "asdf",
"promo_code_creation_time": 1629892385,
"promo_code_start_time": "22 Aug 2021",
"promo_code_end_time": "24 Aug 2021",
"promo_code_used": 0,
"usd_discount": 100,
"max_usd_discount_amount": 0,
"packages": "12511"
},
{
"promo_code_id": 18721,
"promo_code_type": "promo_code_discount",
"promo_code_text": "Hiii",
"discount": 30,
"max_discount_amount": 30,
"promo_code_description": "qwerty",
"promo_code_creation_time": 1629972075,
"promo_code_start_time": "22 Aug 2021",
"promo_code_end_time": "31 Aug 2021",
"promo_code_used": 0,
"usd_discount": 30,
"max_usd_discount_amount": 0,
"packages": "12514"
},
{
"promo_code_id": 18723,
"promo_code_type": "promo_code_discount",
"promo_code_text": "FHGGGFGDG",
"discount": 40,
"max_discount_amount": 40,
"promo_code_description": "TYTGFGH",
"promo_code_creation_time": 1629972106,
"promo_code_start_time": "24 Aug 2021",
"promo_code_end_time": "31 Aug 2021",
"promo_code_used": 0,
"usd_discount": 40,
"max_usd_discount_amount": 0,
"packages": "12514"
},
{
"promo_code_id": 18724,
"promo_code_type": "promo_code_discount",
"promo_code_text": "hii",
"discount": 50,
"max_discount_amount": 150,
"promo_code_description": "hg",
"promo_code_creation_time": 1629975850,
"promo_code_start_time": "26 Aug 2021",
"promo_code_end_time": "31 Aug 2021",
"promo_code_used": 0,
"usd_discount": 50,
"max_usd_discount_amount": 0,
"packages": "12634,2229"
},
{
"promo_code_id": 18917,
"promo_code_type": "promo_code_discount",
"promo_code_text": "DhrumilTest",
"discount": 50,
"max_discount_amount": 10000,
"promo_code_description": "dbfisj",
"promo_code_creation_time": 1643875292,
"promo_code_start_time": "13 Sep 2021",
"promo_code_end_time": "28 Feb 2022",
"promo_code_used": 0,
"usd_discount": 50,
"max_usd_discount_amount": 0,
"packages": "1980"
},
{
"promo_code_id": 18918,
"promo_code_type": "promo_code_discount",
"promo_code_text": "abhi",
"discount": 10,
"max_discount_amount": 5,
"promo_code_description": "sfs",
"promo_code_creation_time": 1631601454,
"promo_code_start_time": "13 Sep 2021",
"promo_code_end_time": "17 Sep 2021",
"promo_code_used": 0,
"usd_discount": 10,
"max_usd_discount_amount": 0,
"packages": "12646"
},
{
"promo_code_id": 18984,
"promo_code_type": "promo_code_discount",
"promo_code_text": "CHAN10",
"discount": 10,
"max_discount_amount": 1000,
"promo_code_description": "Hi",
"promo_code_creation_time": 1632996784,
"promo_code_start_time": "01 Sep 2021",
"promo_code_end_time": "31 Oct 2021",
"promo_code_used": 0,
"usd_discount": 10,
"max_usd_discount_amount": 0,
"packages": "1369,1369"
},
{
"promo_code_id": 19276,
"promo_code_type": "promo_code_discount",
"promo_code_text": "jbassssssssssssssssssssdssssssss",
"discount": 21,
"max_discount_amount": 200,
"promo_code_description": "sadsad",
"promo_code_creation_time": 1637049975,
"promo_code_start_time": "16 Nov 2021",
"promo_code_end_time": "23 Nov 2021",
"promo_code_used": 0,
"usd_discount": 21,
"max_usd_discount_amount": 0,
"packages": "1370"
},
{
"promo_code_id": 19377,
"promo_code_type": "promo_code_discount",
"promo_code_text": "aSAsdadddddddddddddasdasdddddddd",
"discount": 12,
"max_discount_amount": 12,
"promo_code_description": "asdsad",
"promo_code_creation_time": 1637065117,
"promo_code_start_time": "23 Nov 2021",
"promo_code_end_time": "01 Dec 2021",
"promo_code_used": 0,
"usd_discount": 12,
"max_usd_discount_amount": 0,
"packages": "1371"
}
],
"page_context": {
"page": 1,
"per_page": 25,
"has_more_page": true,
"total_rows": 55
}
}Access: Institute admins, plus custom roles that can view promo codes, manage learners or create admissions.
Query parameters
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Results per page. Default 50.
searchstring
Matches part of the code text.
promo_code_typeinteger
1 promo codes (default), 2 cashback codes, 3 unique codes. promotype is accepted as another name for it.statusinteger
1 only codes that have not ended yet, 0 only expired codes. Leave it out for both.bundle_idstring
Comma-separated course IDs. Only codes that apply to one of these courses.
promo_mapping_typeinteger
2 only codes mapped to courses, 1 only codes mapped to membership plans.subscription_plan_idinteger
Only codes mapped to this membership plan.
organization_idinteger
Only codes mapped in this organization. You must be a member of it, otherwise you get "ORG ID invalid". Defaults to all your organizations.
Response
codeinteger
Example:
200messagestring
Example:
Successpromo_codesobject[]
Show child attributesHide child attributes
promo_codes.promo_code_idinteger
Example:
101promo_code_discount, promo_code_cashback or unique_codeExample:
promo_code_discountExample:
CODE20Example:
1000Example:
20% offExample:
02 Aug 2019promo_codes.usd_discountinteger
Example:
20Example:
0page_contextobject
Show child attributesHide child attributes
page_context.pageinteger
Example:
1page_context.per_pageinteger
Example:
25page_context.has_more_pageboolean
Example:
truepage_context.total_rowsinteger
Example:
55Notes: Only codes that are mapped to at least one course or membership plan in your organizations are listed. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.