Page Comparison

Excerpt
This method returns the billing term schemes that are allowed to be used by a specific type of subscription. Multiple billing term schemes are returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_type_identifier

(mandatory)

Subscription Type Identifier

The identifier of the type of the subscription that will be using the billing term schemes. The allowed subscription type identifier fields are the following:

Include Page

	v4:subscription_type_identifier
	v4:subscription_type_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "Concurrent Usage BT Scheme",
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "billing_frequencies_set":
            [
                {
                    "default": false,
                    "time_period":
                    {
                        "time_period_value": 2,
                        "time_period_uot": "YEARS"
                    },
                    "name": "Two Years",
                    "code": "TWOYEARS"
                },
                {
                    "default": false,
                    "time_period":
                    {
                        "time_period_value": 3,
                        "time_period_uot": "MONTHS"
                    },
                    "name": "Quarterly",
                    "code": "QUARTERLY"
                },
                {
                    "default": false,
                    "time_period":
                    {
                        "time_period_value": 1,
                        "time_period_uot": "YEARS"
                    },
                    "name": "Annual",
                    "code": "ANNUAL"
                },
                {
                    "default": true,
                    "time_period":
                    {
                        "time_period_value": 1,
                        "time_period_uot": "MONTHS"
                    },
                    "name": "Monthly",
                    "code": "MONTHLY"
                }
            ],
            "id": "DC2EE11DF33A44369B96EC6067F4EFA0",
            "allowed_cycle_day_from": 10,
            "billing_method": "PERIOD",
            "classification": "SUBSCRIPTIONS",
			"requires_prepayment": false,
			"udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "CUBT",
            "allowed_cycle_day_to": null,
            "log_information":
            {
                "updated_date": "2015-03-11T18:06:36",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2015-03-11T18:05:47",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "g_neocleous",
                    "username": "g_neocleous",
                    "id": "80D37EB91123AE12EEABA6232ADA654F"
                },
                "updated_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438"
                }
            },
            "supported_services_set":
            [
                {
                    "id": "56D3DD44DBFA43A0870EBD16C81B2A40",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "4D55A6EC2FF25A44B9945B88940AF1A0",
                        "description": "Sports 2",
                        "code": "Sports 2",
                        "alternative_code": "S2"
                    }
                },
                {
                    "id": "E4D6CD3793824F5A8AFA1F37C339C7AC",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "90578F46460B7C4530BE801CFE5CB9A1",
                        "description": "Movies 2",
                        "code": "Movies 2",
                        "alternative_code": "m2"
                    }
                },
                {
                    "id": "A5FC9D331C6B4808B278CD73E49C9344",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "17540C21EAB9C50D0945F12313B79875",
                        "description": "Silver Basic Package",
                        "code": "Silver",
                        "alternative_code": "SBP"
                    }
                },
                {
                    "id": "3C519D6A73B244CAB3EBCFFF9DECC4E5",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "5B3841D63F6CAE5973366EEAFF3444E3",
                        "description": "Movies 1",
                        "code": "Movies 1",
                        "alternative_code": "M1"
                    }
                },
                {
                    "id": "49E084CBE27E440FA774498EBA92806A",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "E3600383FF2650A594594F10BEB358D5",
                        "description": "Cartoons 2",
                        "code": "Cartoons 2",
                        "alternative_code": "C2"
                    }
                },
                {
                    "id": "096E40E385274041A5B9E046AC3082C3",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "EBAC84F9A0086191BD58B624D236D61D",
                        "description": "Sports 1",
                        "code": "Sports 1",
                        "alternative_code": "S1"
                    }
                },
                {
                    "id": "2AA60B8AE6A34E79934FDE6D0B94504F",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "A15149563AC0E7D3613F3C1B6E2EE4F5",
                        "description": "Standard Premium Package
",
                        "code": "Standard",
                        "alternative_code": "S"
                    }
                },
                {
                    "id": "61CDB40776624ADAABC59EE80F29A43A",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "AEBE16E35266108071DCCF388B696369",
                        "description": "Pay Per View Service",
                        "code": "Pay Per View Service",
                        "alternative_code": "PPV"
                    }
                },
                {
                    "id": "F9D473865F5240E9A8A6BE10D3647EBB",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "CA3ACA47666F6CB6EECB3C15D1F0221A",
                        "description": "Cartoons 1",
                        "code": "Cartoons 1 ",
                        "alternative_code": "C1"
                    }
                },
                {
                    "id": "5EAD7215ADD84192BD0D6A8E0DF8C487",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "2C0E72A735F71582FFC765F3421CE6A5",
                        "description": "Platinum Premium Package",
                        "code": "Platinum",
                        "alternative_code": "PS"
                    }
                },
                {
                    "id": "20ED1FDAD13D48DD95E184B95AA9F33C",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                        "description": "Gold Premium Package",
                        "code": "Gold",
                        "alternative_code": "GPP"
                    }
                },
                {
                    "id": "0351EEA954784ABCB094C6075F494F45",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
                        "description": "Bronze Premium Package",
                        "code": "Bronze",
                        "alternative_code": "BP"
                    }
                },
                {
                    "id": "9F1CE04993654E4C92E19B1A5CF34093",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "DF57C72BAF0260C26BA558CC06862448",
                        "description": "Video On Demand Service",
                        "code": "Video On Demand Service",
                        "alternative_code": "VOD"
                    }
                },
                {
                    "id": "2511CBFAE5FB4794803D8ACC1C5C46DD",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "041FCCF0417D7F41BFAF456107FF0CA5",
                        "description": "Full access to all channels
",
                        "code": "Full Access Premium",
                        "alternative_code": "FAPREM"
                    }
                },
                {
                    "id": "0D0F3BC6DCAD4BB3BB38B1854A37D278",
                    "billing_type": "PRE_BILL",
                    "product":
                    {
                        "id": "198E2349ABA438B6AD3677BF437BDD43",
                        "description": "Standard + Premium Package
",
                        "code": "Standard +",
                        "alternative_code": "S+"
                    }
                }
            ],
            "discount_option": "FLEXIBLE_PRICE",
            "life_cycle_state": "EFFECTIVE",
            "concurent_usage_allowed": 1,
            "binding_periods_set":
            [
                {
                    "default": false,
                    "time_period":
                    {
                        "time_period_value": 2,
                        "time_period_uot": "YEARS"
                    },
                    "name": "24 Months",
                    "code": "TWOYEARS"
                },
                {
                    "default": true,
                    "time_period":
                    {
                        "time_period_value": 1,
                        "time_period_uot": "YEARS"
                    },
                    "name": "Annual",
                    "code": "ANNUAL"
                }
            ],
            "description": null,
            "billing_type": "NORMAL"
        },         
              
....
}

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "data": [
        {
            "billing_method": "PERIOD",
            "code": "PP",
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2017-09-29T12:26:31",
                "updated_date": "2017-10-02T15:53:26",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "description": "test",
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "discount_option": "FLEXIBLE_PRICE",
            "udf_float_4": null,
            "billing_type": "PREPAID",
            "supported_services_set": [
                {
                    "product": {
                        "code": "Otenet FL Bouquet",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": false,
                            "alternative_code": "FSB",
                            "udr_type": null,
                            "composition_method": "FLEXIBLEBUNDLE",
                            "name": "Flexible Service Bundles",
                            "description": "Flexible Service Bundles",
                            "id": "F78EC7EA238542AF9C51A5550A1A969A",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "OFLB",
                        "description": "Get the Bronze Package and add up to 3 additional services",
                        "id": "B00022BEB678417686FC9D8B7BD06192",
                        "priority_level": null
                    },
                    "billing_type": "POST_RATE",
                    "id": "90B3B93C8B634190B6504ED9AE98E4BE"
                },
                {
                    "product": {
                        "code": "Silver",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "SLV",
                        "description": "SILVER",
                        "id": "AF390B58BCE646D485EAC39D44C2C81C",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "7807340290434EFAA0587082CF44A7A7",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 30
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 20
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 12
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 4
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 10
                        }
                    ]
                },
                {
                    "product": {
                        "code": "Sports 1",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "S1",
                        "description": "Sports 1",
                        "id": "02191FFC231D4FBD844D0BB66EBAB14B",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "8E9EB85D352B4584A8955FE44995EF92",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 30
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 15
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 20
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 10
                        }
                    ]
                },
                {
                    "product": {
                        "code": "MTV",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M_1",
                        "description": "MTV",
                        "id": "937C439D5C4F48588FC75D0F832DD62F",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "63BC42E0BD694674A94012157990CC2A",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 20
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 30
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 10
                        }
                    ]
                },
                {
                    "product": {
                        "code": "Tax Main",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "TM",
                        "description": "Tax Main 1",
                        "id": "BF1090D0BB4E40E6A2C8AB95DD8856A1",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "E8A058B639C44F4CA1E7854EF6C82E0C",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 10
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 20
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 5
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 30
                        }
                    ]
                },
                {
                    "product": {
                        "code": "Movies 1",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M1",
                        "description": "Movies 1",
                        "id": "571C10876AF840088372A94A14D0A02C",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "899E75BEECA343EAADD4F9CEE699F317",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 30
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 20
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 10
                        }
                    ]
                },
                {
                    "product": {
                        "code": "Bronze",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "B",
                        "description": "Bronze",
                        "id": "F50CC52934BD4F119B6E18E215A4FC55",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "909FEA47DFDB4EF6AB377BF07E47344F",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 10
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 30
                        },
                        {
                            "period_billed_in_advance_uot": "MONTHS",
                            "is_default": false,
                            "period_billed_in_advance": 1
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 20
                        }
                    ]
                },
                {
                    "product": {
                        "code": "Music1",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M",
                        "description": "Music1",
                        "id": "D6453416BB704BC4A5448C06F361B5D3",
                        "priority_level": null
                    },
                    "billing_type": "POST_RATE",
                    "id": "4C59687E7B5C4D4CB483A8D2D2534864"
                },
                {
                    "product": {
                        "code": "Gold",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "G",
                        "description": "Gold",
                        "id": "D1EB074DFD904E54A0C67CAB9DC7E010",
                        "priority_level": null
                    },
                    "billing_type": "PRE_RATE",
                    "id": "B8E39E96768A4E93928408E394EB36E5",
                    "periods_billed_in_advance": [
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 10
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": true,
                            "period_billed_in_advance": 20
                        },
                        {
                            "period_billed_in_advance_uot": "DAYS",
                            "is_default": false,
                            "period_billed_in_advance": 30
                        }
                    ]
                }
            ],
            "id": "7EB1560CBAE449FCB7ED7EF8F9A3C71E",
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "concurent_usage_allowed": false,
            "udf_string_5": null,
            "billing_frequencies_set": [],
            "udf_string_1": null,
            "life_cycle_state": "EFFECTIVE",
            "classification": "SUBSCRIPTIONS",
            "requires_prepayment": false,
            "binding_periods_set": [],
            "name": "Prerate Periods",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 5

New Version 6

Key