Skip to end of banner
Go to start of banner

POST usage_detail_records/cancel_lot

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Available from CRM.COM R13.0.0

This method cancels multiple existing usage detail records, which are in Posted state. Multiple usage records can be updated by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_action_identifier

(mandatory)

Subscription Action identifier  


The subscription action identifier that should be used for cancelling the usage detail record lot. The allowed subscription action identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the subscription action

number 

(semi-optional)

String

The number of the subscription action

transaction_reference_number

(semi-optional)

String

The unique transaction reference number of the subscription action

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Available from CRM.COM R13.0.0

Name

Type

Description

id

String

The ID of the retrieved usage detail record

number

String

The number of the retrieved usage detail record

life_cycle_stateString

The state of the retrieved usage detail record which can be one of the following:

POSTED, CANCELLED

transaction_reference_number

 

String

The unique transaction reference number of the retrieved usage detail record action

subscriptionSubscription objectThe related subscription object
subscription_serviceSubscription Service objectThe related subscription service object, which is classified as a usage service
productProduct objectThe actual product that was used, which is classified as a usage service
unit_of_measurementUnits of Measurement Object

The Unit of measurement of the retrieved usage detail record type

Available from CRM.COM R13.0.0

Referred Objects Response Data

 subscription object response data

Name

Type

Description

id

String

The ID of the retrieved subscription

number

String

The number of the retrieved subscription

life_cycle_state

String

The life cycle state of the subscription. One of the following values is returned

DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION

REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0

PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0

first_activated_dateDate

The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started)

Available from CRM.COM R9.0.0

rating_stateString

The rating state of the retrieved subscription that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

accounts_receivableAccounts receivable objectThe accounts receivable owning the subscriptions
typeSubscription type objectThe type of the retrieved subscription

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 subscription type object response data

Name

Type

Description

id

String

The ID of the retrieved subscription type

name

String

The name of the retrieved subscription type

alternative_code

String

The alternative code of the retrieved subscription type

descriptionStringA description of the retrieved subscription type
classificationString

The classification of the retrieved subscription type, Flexible or Package

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0

 termed_subscription_service object response data

Name

Type

Description

id

String

The ID of the retrieved termed subscription service

life_cycle_state

String

The life cycle state of the termed subscription service. One of the following values is returned:

DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED

REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0

mandatoryBoolean

Defines whether the retrieved termed service was added on the subscription as a mandatory or an additional one.

Available from CRM.COM R15.0.0

first_activated_dateDate

The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started)

Available from CRM.COM R9.0.0

rating_stateString

The rating state of the retrieved subscription service that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

rated_up_toDate

The date up until which the termed service was rated.

Available from CRM.COM R9.0.0

freeBoolean

Indicates whether the retrieved service is classified as Free or a Paid one. If true then the service is a free service

Available from CRM.COM R14.2.0

trial_end_dateDate

Defines the end of the service's trial period, if any

Available from CRM.COM R14.17.0

udf_string_1 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_2 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_3 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_4 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_5

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_6 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_7

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_8

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_float_1

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_2

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_3

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_4

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_date_1 

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_2 

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_3

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_4

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

period_billed_in_advancePeriod Billed in Advance Object

Defines the period that the specified service will be billed in advance. Applicable only for prepaid pre-rated services

Available from CRM.COM R14.0.0

productProduct objectThe product classified as termed service which is related with the retrieved termed subscription service
service_bundleSubscription Service Bundle Object

The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.


Referred Objects Response Data

 period billed in advance object response data

Name

Type

Description

period_billed_in_advance

Integer

Defines the period for which the the service will be pre-rated. Applicable only for prepaid services of PRERATE billing type

period_billed_in_advance_uot

String

The unit of time that measures the specified period billed in advance for the service. The supported values are DAYS, WEEKS or MONTHS. Applicable only for prepaid services of PRERATE billing type


 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 termed_subscription_service_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved termed subscription service

life_cycle_state

String

The life cycle state of the termed subscription service. One of the following values is returned:

DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHIRT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED

REPLACED available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0

first_activated_dateDate

The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started)

Available from CRM.COM R9.0.0

rating_stateString

The rating state of the retrieved subscription service that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

rated_up_toDate

The date up until which the termed service was rated.

Available from CRM.COM R9.0.0

productProduct objectThe product classified as termed service which is related with the retrieved termed subscription service

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

Examples

 Example 1

HTTP Method: POST

 

Request:

 

Body:

 {
    "token": "{{token}}",
    "subscription_action_identifier":{"id":"00B8A9381A994A4CABDC9716F866B77C"}
}

 

Response:

 {
  "data": [
    {
      "number": "214",
      "subscription_service": {
        "product": {
          "code": "VOD & PPV Base",
          "product_type": {
            "service_type": "TERMED",
            "used_for_provisioning": false,
            "alternative_code": "V&P",
            "composition_method": "FLAT",
            "name": "VOD & PPV",
            "description": "To be used for termed non provisioning services as a base for ordering VOD and PPV",
            "id": "CE2024C589D34244A1D29CDDE3B88127",
            "classification": "SERVICES",
            "physical_good_type": null
          },
          "alternative_code": "V&PB",
          "description": "VOD & PPV Base",
          "id": "F7286EF7D017405E8357FF8614A3EA24"
        },
        "first_activated_date": "2016-10-21T14:00:38",
        "rating_state": "PENDING",
        "service_bundle": null,
        "rated_up_to_date": null,
        "id": "D3C50E4E5B924B798FF436B7C25DB570",
        "life_cycle_state": "EFFECTIVE"
      },
      "product": {
        "code": "Serendipity",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": true,
          "alternative_code": "V",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "A",
              "name": "Amount",
              "description": null,
              "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
            },
            "alternative_code": "V",
            "name": "VOD",
            "description": null,
            "id": "B3CFC986221548279752B1ABC6F4C480"
          },
          "composition_method": "FLAT",
          "name": "Usage Services",
          "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
          "id": "751C638AA3534B768408AAC4D73CF516",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "S_1",
        "description": "VOD: Serendipity ",
        "id": "BD3ACEE7D6244DCAA375D0744DA75540"
      },
      "unit_of_measurement": {
        "alternative_code": "A",
        "name": "Amount",
        "description": null,
        "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
      },
      "transaction_reference_number": null,
      "id": "93CA2251A0C94A33A66F70D62DC9EE3F",
      "life_cycle_state": "CANCELLED",
      "subscription": {
        "number": "S0000000278",
        "first_activated_date": "2016-10-21T14:00:38",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000132",
          "name": "ACR0000000132 Melissa Ioannou",
          "id": "4653431C51AD4A28A4A8D2286E9146E7",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Melissa Ioannou",
            "last_name": "Ioannou",
            "id": "D36C847F516B417D98242B55ECBF67D0",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Melissa",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "336655",
              "gender": "MALE",
              "country_of_residence": {
                "alternative_code": "IRN",
                "three_character_code": null,
                "name": "IRAN (ISLAMIC REPUBLIC OF)",
                "id": "231",
                "two_character_code": null
              },
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "A120C3C6949D414EB0F1D5A70FCDD9C0",
        "life_cycle_state": "EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
  • No labels