Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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
titleExample 2

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "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": ""
    }
}