Key |
Returned |
Description |
subscribed_services
complex
|
on success |
List of SubscribedService resources
Sample:
[{'admin_email': 'admin_email_example', 'agreement_id': 56, 'agreement_name': 'agreement_name_example', 'agreement_type': 'agreement_type_example', 'available_amount': 'available_amount_example', 'bill_to_address': {'bill_site_use_id': 56, 'is_bill_to': True, 'is_ship_to': True, 'location': {'address1': 'address1_example', 'address2': 'address2_example', 'city': 'city_example', 'country': 'country_example', 'postal_code': 'postal_code_example', 'region': 'us-phoenix-1', 'tca_location_id': 56}, 'name': 'name_example', 'phone': 'phone_example', 'service2_site_use_id': 56, 'tca_cust_acct_site_id': 56, 'tca_party_site_number': 'tca_party_site_number_example'}, 'bill_to_contact': {'email': 'email_example', 'first_name': 'first_name_example', 'last_name': 'last_name_example', 'name': 'name_example', 'tca_contact_id': 56, 'tca_cust_accnt_site_id': 56, 'tca_party_id': 56, 'username': 'username_example'}, 'bill_to_customer': {'customer_chain_type': 'customer_chain_type_example', 'is_chain_customer': True, 'is_public_sector': True, 'name': 'name_example', 'name_phonetic': 'name_phonetic_example', 'tca_cust_account_number': 'tca_cust_account_number_example', 'tca_customer_account_id': 56, 'tca_party_id': 56, 'tca_party_number': 'tca_party_number_example'}, 'billing_frequency': 'billing_frequency_example', 'booking_opty_number': 'booking_opty_number_example', 'buyer_email': 'buyer_email_example', 'commitment_schedule_id': 'ocid1.commitmentschedule.oc1..xxxxxxEXAMPLExxxxxx', 'commitment_services': [{'available_amount': 'available_amount_example', 'funded_allocation_value': 'funded_allocation_value_example', 'line_net_amount': 'line_net_amount_example', 'quantity': 'quantity_example', 'time_end': '2013-10-20T19:20:30+01:00', 'time_start': '2013-10-20T19:20:30+01:00'}], 'created_by': 'created_by_example', 'credit_percentage': 'credit_percentage_example', 'csi': 56, 'customer_transaction_reference': 'customer_transaction_reference_example', 'data_center': 'data_center_example', 'data_center_region': 'us-phoenix-1', 'eligible_to_renew': 'eligible_to_renew_example', 'end_user_address': {'bill_site_use_id': 56, 'is_bill_to': True, 'is_ship_to': True, 'location': {'address1': 'address1_example', 'address2': 'address2_example', 'city': 'city_example', 'country': 'country_example', 'postal_code': 'postal_code_example', 'region': 'us-phoenix-1', 'tca_location_id': 56}, 'name': 'name_example', 'phone': 'phone_example', 'service2_site_use_id': 56, 'tca_cust_acct_site_id': 56, 'tca_party_site_number': 'tca_party_site_number_example'}, 'end_user_contact': {'email': 'email_example', 'first_name': 'first_name_example', 'last_name': 'last_name_example', 'name': 'name_example', 'tca_contact_id': 56, 'tca_cust_accnt_site_id': 56, 'tca_party_id': 56, 'username': 'username_example'}, 'end_user_customer': {'customer_chain_type': 'customer_chain_type_example', 'is_chain_customer': True, 'is_public_sector': True, 'name': 'name_example', 'name_phonetic': 'name_phonetic_example', 'tca_cust_account_number': 'tca_cust_account_number_example', 'tca_customer_account_id': 56, 'tca_party_id': 56, 'tca_party_number': 'tca_party_number_example'}, 'fulfillment_set': 'fulfillment_set_example', 'funded_allocation_value': 'funded_allocation_value_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_allowance': True, 'is_cap_to_price_list': True, 'is_credit_enabled': True, 'is_having_usage': True, 'is_intent_to_pay': True, 'is_payg': True, 'is_single_rate_card': True, 'is_variable_commitment': True, 'line_net_amount': 'line_net_amount_example', 'major_set': 56, 'net_unit_price': 'net_unit_price_example', 'operation_type': 'operation_type_example', 'order_header_id': 56, 'order_line_id': 56, 'order_line_number': 56, 'order_number': 56, 'order_type': 'order_type_example', 'original_promo_amount': 'original_promo_amount_example', 'overage_bill_to': 'overage_bill_to_example', 'overage_discount_percentage': 'overage_discount_percentage_example', 'overage_policy': 'overage_policy_example', 'partner_credit_amount': 'partner_credit_amount_example', 'partner_transaction_type': 'partner_transaction_type_example', 'payg_policy': 'payg_policy_example', 'payment_method': 'payment_method_example', 'payment_number': 'payment_number_example', 'payment_term': {'created_by': 'created_by_example', 'description': 'description_example', 'is_active': True, 'name': 'name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'updated_by': 'updated_by_example', 'value': 'value_example'}, 'price_period': 'price_period_example', 'pricing_model': 'pricing_model_example', 'product': {'billing_category': 'billing_category_example', 'name': 'name_example', 'part_number': 'part_number_example', 'product_category': 'product_category_example', 'ucm_rate_card_part_type': 'ucm_rate_card_part_type_example', 'unit_of_measure': 'unit_of_measure_example'}, 'program_type': 'program_type_example', 'promo_order_line_id': 56, 'promo_type': 'promo_type_example', 'promotion_pricing_type': 'promotion_pricing_type_example', 'provisioning_source': 'provisioning_source_example', 'quantity': 'quantity_example', 'rate_card_discount_percentage': 'rate_card_discount_percentage_example', 'rate_cards': [{'currency': {'iso_code': 'iso_code_example', 'name': 'name_example', 'std_precision': 56}, 'discretionary_discount_percentage': 'discretionary_discount_percentage_example', 'is_tier': True, 'net_unit_price': 'net_unit_price_example', 'overage_price': 'overage_price_example', 'product': {'billing_category': 'billing_category_example', 'name': 'name_example', 'part_number': 'part_number_example', 'product_category': 'product_category_example', 'ucm_rate_card_part_type': 'ucm_rate_card_part_type_example', 'unit_of_measure': 'unit_of_measure_example'}, 'rate_card_tiers': [{'net_unit_price': 'net_unit_price_example', 'overage_price': 'overage_price_example', 'up_to_quantity': 'up_to_quantity_example'}], 'subscribed_service_id': 'ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx', 'time_end': '2013-10-20T19:20:30+01:00', 'time_start': '2013-10-20T19:20:30+01:00'}], 'ratecard_type': 'ratecard_type_example', 'renewal_opty_id': 56, 'renewal_opty_number': 'renewal_opty_number_example', 'renewal_opty_type': 'renewal_opty_type_example', 'renewed_subscribed_service_id': 'ocid1.renewedsubscribedservice.oc1..xxxxxxEXAMPLExxxxxx', 'reseller_address': {'bill_site_use_id': 56, 'is_bill_to': True, 'is_ship_to': True, 'location': {'address1': 'address1_example', 'address2': 'address2_example', 'city': 'city_example', 'country': 'country_example', 'postal_code': 'postal_code_example', 'region': 'us-phoenix-1', 'tca_location_id': 56}, 'name': 'name_example', 'phone': 'phone_example', 'service2_site_use_id': 56, 'tca_cust_acct_site_id': 56, 'tca_party_site_number': 'tca_party_site_number_example'}, 'reseller_contact': {'email': 'email_example', 'first_name': 'first_name_example', 'last_name': 'last_name_example', 'name': 'name_example', 'tca_contact_id': 56, 'tca_cust_accnt_site_id': 56, 'tca_party_id': 56, 'username': 'username_example'}, 'reseller_customer': {'customer_chain_type': 'customer_chain_type_example', 'is_chain_customer': True, 'is_public_sector': True, 'name': 'name_example', 'name_phonetic': 'name_phonetic_example', 'tca_cust_account_number': 'tca_cust_account_number_example', 'tca_customer_account_id': 56, 'tca_party_id': 56, 'tca_party_number': 'tca_party_number_example'}, 'revenue_line_id': 56, 'revenue_line_number': 'revenue_line_number_example', 'revised_arr_in_lc': 'revised_arr_in_lc_example', 'revised_arr_in_sc': 'revised_arr_in_sc_example', 'sales_account_party_id': 56, 'sales_channel': 'sales_channel_example', 'serial_number': 'serial_number_example', 'service_to_address': {'bill_site_use_id': 56, 'is_bill_to': True, 'is_ship_to': True, 'location': {'address1': 'address1_example', 'address2': 'address2_example', 'city': 'city_example', 'country': 'country_example', 'postal_code': 'postal_code_example', 'region': 'us-phoenix-1', 'tca_location_id': 56}, 'name': 'name_example', 'phone': 'phone_example', 'service2_site_use_id': 56, 'tca_cust_acct_site_id': 56, 'tca_party_site_number': 'tca_party_site_number_example'}, 'service_to_contact': {'email': 'email_example', 'first_name': 'first_name_example', 'last_name': 'last_name_example', 'name': 'name_example', 'tca_contact_id': 56, 'tca_cust_accnt_site_id': 56, 'tca_party_id': 56, 'username': 'username_example'}, 'service_to_customer': {'customer_chain_type': 'customer_chain_type_example', 'is_chain_customer': True, 'is_public_sector': True, 'name': 'name_example', 'name_phonetic': 'name_phonetic_example', 'tca_cust_account_number': 'tca_cust_account_number_example', 'tca_customer_account_id': 56, 'tca_party_id': 56, 'tca_party_number': 'tca_party_number_example'}, 'sold_to_contact': {'email': 'email_example', 'first_name': 'first_name_example', 'last_name': 'last_name_example', 'name': 'name_example', 'tca_contact_id': 56, 'tca_cust_accnt_site_id': 56, 'tca_party_id': 56, 'username': 'username_example'}, 'sold_to_customer': {'customer_chain_type': 'customer_chain_type_example', 'is_chain_customer': True, 'is_public_sector': True, 'name': 'name_example', 'name_phonetic': 'name_phonetic_example', 'tca_cust_account_number': 'tca_cust_account_number_example', 'tca_customer_account_id': 56, 'tca_party_id': 56, 'tca_party_number': 'tca_party_number_example'}, 'start_date_type': 'start_date_type_example', 'status': 'status_example', 'subscription_id': 'ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx', 'subscription_source': 'subscription_source_example', 'system_arr_in_lc': 'system_arr_in_lc_example', 'system_arr_in_sc': 'system_arr_in_sc_example', 'system_atr_arr_in_lc': 'system_atr_arr_in_lc_example', 'system_atr_arr_in_sc': 'system_atr_arr_in_sc_example', 'term_value': 56, 'term_value_uom': 'term_value_uom_example', 'time_agreement_end': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'time_customer_config': '2013-10-20T19:20:30+01:00', 'time_end': '2013-10-20T19:20:30+01:00', 'time_majorset_end': '2013-10-20T19:20:30+01:00', 'time_majorset_start': '2013-10-20T19:20:30+01:00', 'time_payment_expiry': '2013-10-20T19:20:30+01:00', 'time_provisioned': '2013-10-20T19:20:30+01:00', 'time_service_configuration_email_sent': '2013-10-20T19:20:30+01:00', 'time_start': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'time_welcome_email_sent': '2013-10-20T19:20:30+01:00', 'total_value': 'total_value_example', 'transaction_extension_id': 56, 'type': 'type_example', 'updated_by': 'updated_by_example', 'used_amount': 'used_amount_example'}]
|
|
admin_email
string
|
on success |
Subscribed service admin email id
Sample:
admin_email_example
|
|
agreement_id
integer
|
on success |
Subscribed service agreement ID
Sample:
56
|
|
agreement_name
string
|
on success |
Subscribed service agrrement name
Sample:
agreement_name_example
|
|
agreement_type
string
|
on success |
Subscribed service agrrement type
Sample:
agreement_type_example
|
|
available_amount
string
|
on success |
Subscribed sercice available or remaining amount
Sample:
available_amount_example
|
|
bill_to_address
complex
|
on success |
|
|
|
bill_site_use_id
integer
|
on success |
Bill to site use Id.
Sample:
56
|
|
|
is_bill_to
boolean
|
on success |
Identify as the customer shipping address.
Sample:
True
|
|
|
is_ship_to
boolean
|
on success |
Identify as the customer invoicing address.
Sample:
True
|
|
|
location
complex
|
on success |
|
|
|
|
address1
string
|
on success |
Address first line.
Sample:
address1_example
|
|
|
|
address2
string
|
on success |
Address second line.
Sample:
address2_example
|
|
|
|
city
string
|
on success |
City.
Sample:
city_example
|
|
|
|
country
string
|
on success |
Country.
Sample:
country_example
|
|
|
|
postal_code
string
|
on success |
Postal code.
Sample:
postal_code_example
|
|
|
|
region
string
|
on success |
Region.
Sample:
us-phoenix-1
|
|
|
|
tca_location_id
integer
|
on success |
Region.
Sample:
56
|
|
|
name
string
|
on success |
Address name identifier.
Sample:
name_example
|
|
|
phone
string
|
on success |
Phone.
Sample:
phone_example
|
|
|
service2_site_use_id
integer
|
on success |
Service to site use Id.
Sample:
56
|
|
|
tca_cust_acct_site_id
integer
|
on success |
TCA customer account site Id.
Sample:
56
|
|
|
tca_party_site_number
string
|
on success |
Party site number.
Sample:
tca_party_site_number_example
|
|
bill_to_contact
complex
|
on success |
|
|
|
email
string
|
on success |
Email.
Sample:
email_example
|
|
|
first_name
string
|
on success |
First name.
Sample:
first_name_example
|
|
|
last_name
string
|
on success |
Last name.
Sample:
last_name_example
|
|
|
name
string
|
on success |
Name.
Sample:
name_example
|
|
|
tca_contact_id
integer
|
on success |
TCA contact ID.
Sample:
56
|
|
|
tca_cust_accnt_site_id
integer
|
on success |
TCA customer account site ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
username
string
|
on success |
Username.
Sample:
username_example
|
|
bill_to_customer
complex
|
on success |
|
|
|
customer_chain_type
string
|
on success |
Customer chain type.
Sample:
customer_chain_type_example
|
|
|
is_chain_customer
boolean
|
on success |
The business partner is chain customer or not.
Sample:
True
|
|
|
is_public_sector
boolean
|
on success |
The business partner is part of the public sector or not.
Sample:
True
|
|
|
name
string
|
on success |
Commercial name also called customer name.
Sample:
name_example
|
|
|
name_phonetic
string
|
on success |
Phonetic name.
Sample:
name_phonetic_example
|
|
|
tca_cust_account_number
string
|
on success |
TCA customer account number.
Sample:
tca_cust_account_number_example
|
|
|
tca_customer_account_id
integer
|
on success |
TCA customer account ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
tca_party_number
string
|
on success |
TCA party number.
Sample:
tca_party_number_example
|
|
billing_frequency
string
|
on success |
Subscribed service invoice frequency
Sample:
billing_frequency_example
|
|
booking_opty_number
string
|
on success |
Booking Opportunity Number of Subscribed Service
Sample:
booking_opty_number_example
|
|
buyer_email
string
|
on success |
Subscribed service buyer email id
Sample:
buyer_email_example
|
|
commitment_schedule_id
string
|
on success |
Subscribed service commitment schedule Id
Sample:
ocid1.commitmentschedule.oc1..xxxxxxEXAMPLExxxxxx
|
|
commitment_services
complex
|
on success |
List of Commitment services of a line
Returned for get operation
|
|
|
available_amount
string
|
on success |
Commitment available amount
Sample:
available_amount_example
|
|
|
funded_allocation_value
string
|
on success |
Funded Allocation line value
Sample:
funded_allocation_value_example
|
|
|
line_net_amount
string
|
on success |
Commitment line net amount
Sample:
line_net_amount_example
|
|
|
quantity
string
|
on success |
Commitment quantity
Sample:
quantity_example
|
|
|
time_end
string
|
on success |
Commitment end date
Sample:
2013-10-20T19:20:30+01:00
|
|
|
time_start
string
|
on success |
Commitment start date
Sample:
2013-10-20T19:20:30+01:00
|
|
created_by
string
|
on success |
User that created the subscribed service
Sample:
created_by_example
|
|
credit_percentage
string
|
on success |
Subscribed service credit percentage
Sample:
credit_percentage_example
|
|
csi
integer
|
on success |
Subscribed service CSI number
Sample:
56
|
|
customer_transaction_reference
string
|
on success |
Identifier for a customer's transactions for purchase of ay oracle services
Sample:
customer_transaction_reference_example
|
|
data_center
string
|
on success |
Subscribed service data center
Sample:
data_center_example
|
|
data_center_region
string
|
on success |
Subscribed service data center region
Sample:
us-phoenix-1
|
|
eligible_to_renew
string
|
on success |
Subscribed service eligible to renew field
Sample:
eligible_to_renew_example
|
|
end_user_address
complex
|
on success |
|
|
|
bill_site_use_id
integer
|
on success |
Bill to site use Id.
Sample:
56
|
|
|
is_bill_to
boolean
|
on success |
Identify as the customer shipping address.
Sample:
True
|
|
|
is_ship_to
boolean
|
on success |
Identify as the customer invoicing address.
Sample:
True
|
|
|
location
complex
|
on success |
|
|
|
|
address1
string
|
on success |
Address first line.
Sample:
address1_example
|
|
|
|
address2
string
|
on success |
Address second line.
Sample:
address2_example
|
|
|
|
city
string
|
on success |
City.
Sample:
city_example
|
|
|
|
country
string
|
on success |
Country.
Sample:
country_example
|
|
|
|
postal_code
string
|
on success |
Postal code.
Sample:
postal_code_example
|
|
|
|
region
string
|
on success |
Region.
Sample:
us-phoenix-1
|
|
|
|
tca_location_id
integer
|
on success |
Region.
Sample:
56
|
|
|
name
string
|
on success |
Address name identifier.
Sample:
name_example
|
|
|
phone
string
|
on success |
Phone.
Sample:
phone_example
|
|
|
service2_site_use_id
integer
|
on success |
Service to site use Id.
Sample:
56
|
|
|
tca_cust_acct_site_id
integer
|
on success |
TCA customer account site Id.
Sample:
56
|
|
|
tca_party_site_number
string
|
on success |
Party site number.
Sample:
tca_party_site_number_example
|
|
end_user_contact
complex
|
on success |
|
|
|
email
string
|
on success |
Email.
Sample:
email_example
|
|
|
first_name
string
|
on success |
First name.
Sample:
first_name_example
|
|
|
last_name
string
|
on success |
Last name.
Sample:
last_name_example
|
|
|
name
string
|
on success |
Name.
Sample:
name_example
|
|
|
tca_contact_id
integer
|
on success |
TCA contact ID.
Sample:
56
|
|
|
tca_cust_accnt_site_id
integer
|
on success |
TCA customer account site ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
username
string
|
on success |
Username.
Sample:
username_example
|
|
end_user_customer
complex
|
on success |
|
|
|
customer_chain_type
string
|
on success |
Customer chain type.
Sample:
customer_chain_type_example
|
|
|
is_chain_customer
boolean
|
on success |
The business partner is chain customer or not.
Sample:
True
|
|
|
is_public_sector
boolean
|
on success |
The business partner is part of the public sector or not.
Sample:
True
|
|
|
name
string
|
on success |
Commercial name also called customer name.
Sample:
name_example
|
|
|
name_phonetic
string
|
on success |
Phonetic name.
Sample:
name_phonetic_example
|
|
|
tca_cust_account_number
string
|
on success |
TCA customer account number.
Sample:
tca_cust_account_number_example
|
|
|
tca_customer_account_id
integer
|
on success |
TCA customer account ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
tca_party_number
string
|
on success |
TCA party number.
Sample:
tca_party_number_example
|
|
fulfillment_set
string
|
on success |
Subscribed service fulfillment set
Sample:
fulfillment_set_example
|
|
funded_allocation_value
string
|
on success |
Funded Allocation line value example: 12000.00
Sample:
funded_allocation_value_example
|
|
id
string
|
on success |
SPM internal Subscribed Service ID
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
is_allowance
boolean
|
on success |
Indicates if a service can recieve usages and consequently have available amounts computed
Sample:
True
|
|
is_cap_to_price_list
boolean
|
on success |
If true compares rate between ratecard and the active pricelist and minimum rate would be fetched
Sample:
True
|
|
is_credit_enabled
boolean
|
on success |
Used in context of service credit lines
Sample:
True
|
|
is_having_usage
boolean
|
on success |
Indicator on whether or not there has been usage for the subscribed service
Sample:
True
|
|
is_intent_to_pay
boolean
|
on success |
Subscribed service intent to pay flag
Sample:
True
|
|
is_payg
boolean
|
on success |
Subscribed service payg flag
Sample:
True
|
|
is_single_rate_card
boolean
|
on success |
Indicates if the Subscribed service has a single ratecard
Sample:
True
|
|
is_variable_commitment
boolean
|
on success |
Indicates if the commitment lines can have different quantities
Sample:
True
|
|
line_net_amount
string
|
on success |
Subscribed service line net amount
Sample:
line_net_amount_example
|
|
major_set
integer
|
on success |
Subscribed service Major Set
Sample:
56
|
|
net_unit_price
string
|
on success |
Subscribed service net unit price
Sample:
net_unit_price_example
|
|
operation_type
string
|
on success |
Subscribed service operation type
Sample:
operation_type_example
|
|
order_header_id
integer
|
on success |
Sales Order Header associated to the subscribed service
Sample:
56
|
|
order_line_id
integer
|
on success |
Sales Order Line Id associated to the subscribed service
Sample:
56
|
|
order_line_number
integer
|
on success |
Sales Order Line Number associated to the subscribed service
Sample:
56
|
|
order_number
integer
|
on success |
Sales Order Number associated to the subscribed service
Sample:
56
|
|
order_type
string
|
on success |
Order Type of Subscribed Service
Sample:
order_type_example
|
|
original_promo_amount
string
|
on success |
Subscribed service Promotion Amount
Sample:
original_promo_amount_example
|
|
overage_bill_to
string
|
on success |
Overage Bill To of Subscribed Service
Sample:
overage_bill_to_example
|
|
overage_discount_percentage
string
|
on success |
Subscribed service Overage Discount Percentage
Sample:
overage_discount_percentage_example
|
|
overage_policy
string
|
on success |
Overage Policy of Subscribed Service
Sample:
overage_policy_example
|
|
partner_credit_amount
string
|
on success |
Subscribed service partner credit amount
Sample:
partner_credit_amount_example
|
|
partner_transaction_type
string
|
on success |
This field contains the name of the partner to which the subscription belongs - depending on which the invoicing may differ
Sample:
partner_transaction_type_example
|
|
payg_policy
string
|
on success |
Pay As You Go policy of Subscribed Service (Can be null - indicating no payg policy)
Sample:
payg_policy_example
|
|
payment_method
string
|
on success |
Payment Method of Subscribed Service
Sample:
payment_method_example
|
|
payment_number
string
|
on success |
Payment Number of Subscribed Service
Sample:
payment_number_example
|
|
payment_term
complex
|
on success |
|
|
|
created_by
string
|
on success |
User that created the Payment term
Sample:
created_by_example
|
|
|
description
string
|
on success |
Payment term Description
Sample:
description_example
|
|
|
is_active
boolean
|
on success |
Payment term active flag
Sample:
True
|
|
|
name
string
|
on success |
Payment Term name
Sample:
name_example
|
|
|
time_created
string
|
on success |
Payment term last update date
Sample:
2013-10-20T19:20:30+01:00
|
|
|
time_updated
string
|
on success |
Payment term last update date
Sample:
2013-10-20T19:20:30+01:00
|
|
|
updated_by
string
|
on success |
User that updated the Payment term
Sample:
updated_by_example
|
|
|
value
string
|
on success |
Payment Term value
Sample:
value_example
|
|
price_period
string
|
on success |
Indicates the period for which the commitment amount can be utilised exceeding which the amount lapses. Also used in calculation of total contract line value
Sample:
price_period_example
|
|
pricing_model
string
|
on success |
Subscribed service pricing model
Sample:
pricing_model_example
|
|
product
complex
|
on success |
|
|
|
billing_category
string
|
on success |
Metered service billing category
Sample:
billing_category_example
|
|
|
name
string
|
on success |
Product name
Sample:
name_example
|
|
|
part_number
string
|
on success |
Product part numner
Sample:
part_number_example
|
|
|
product_category
string
|
on success |
Product category
Sample:
product_category_example
|
|
|
ucm_rate_card_part_type
string
|
on success |
Rate card part type of Product
Sample:
ucm_rate_card_part_type_example
|
|
|
unit_of_measure
string
|
on success |
Unit of measure
Sample:
unit_of_measure_example
|
|
program_type
string
|
on success |
Subscribed service program type
Sample:
program_type_example
|
|
promo_order_line_id
integer
|
on success |
Not null if this service has an associated promotion line in SPM. Contains the line identifier from Order Management of the associated promo line.
Sample:
56
|
|
promo_type
string
|
on success |
Subscribed service promotion type
Sample:
promo_type_example
|
|
promotion_pricing_type
string
|
on success |
Promotion Pricing Type of Subscribed Service (Can be null - indicating no promotion pricing)
Sample:
promotion_pricing_type_example
|
|
provisioning_source
string
|
on success |
Subscribed service provisioning source
Sample:
provisioning_source_example
|
|
quantity
string
|
on success |
Subscribed service quantity
Sample:
quantity_example
|
|
rate_card_discount_percentage
string
|
on success |
Subscribed service Rate Card Discount Percentage
Sample:
rate_card_discount_percentage_example
|
|
rate_cards
complex
|
on success |
List of Rate Cards of a Subscribed Service
Returned for get operation
|
|
|
currency
complex
|
on success |
|
|
|
|
iso_code
string
|
on success |
Currency Code
Sample:
iso_code_example
|
|
|
|
name
string
|
on success |
Currency name
Sample:
name_example
|
|
|
|
std_precision
integer
|
on success |
Standard Precision of the Currency
Sample:
56
|
|
|
discretionary_discount_percentage
string
|
on success |
Rate card discretionary discount percentage
Sample:
discretionary_discount_percentage_example
|
|
|
is_tier
boolean
|
on success |
Rate card price tier flag
Sample:
True
|
|
|
net_unit_price
string
|
on success |
Rate card net unit price
Sample:
net_unit_price_example
|
|
|
overage_price
string
|
on success |
Rate card overage price
Sample:
overage_price_example
|
|
|
product
complex
|
on success |
|
|
|
|
billing_category
string
|
on success |
Metered service billing category
Sample:
billing_category_example
|
|
|
|
name
string
|
on success |
Product name
Sample:
name_example
|
|
|
|
part_number
string
|
on success |
Product part numner
Sample:
part_number_example
|
|
|
|
product_category
string
|
on success |
Product category
Sample:
product_category_example
|
|
|
|
ucm_rate_card_part_type
string
|
on success |
Rate card part type of Product
Sample:
ucm_rate_card_part_type_example
|
|
|
|
unit_of_measure
string
|
on success |
Unit of measure
Sample:
unit_of_measure_example
|
|
|
rate_card_tiers
complex
|
on success |
List of tiered rate card prices
|
|
|
|
net_unit_price
string
|
on success |
Rate card tier net unit price
Sample:
net_unit_price_example
|
|
|
|
overage_price
string
|
on success |
Rate card tier overage price
Sample:
overage_price_example
|
|
|
|
up_to_quantity
string
|
on success |
Rate card tier quantity range
Sample:
up_to_quantity_example
|
|
|
subscribed_service_id
string
|
on success |
SPM internal Subscribed Service ID
Sample:
ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx
|
|
|
time_end
string
|
on success |
Rate card end date
Sample:
2013-10-20T19:20:30+01:00
|
|
|
time_start
string
|
on success |
Rate card start date
Sample:
2013-10-20T19:20:30+01:00
|
|
ratecard_type
string
|
on success |
SPM Ratecard Type
Sample:
ratecard_type_example
|
|
renewal_opty_id
integer
|
on success |
Subscribed service Opportunity Id
Sample:
56
|
|
renewal_opty_number
string
|
on success |
Renewal Opportunity Number of Subscribed Service
Sample:
renewal_opty_number_example
|
|
renewal_opty_type
string
|
on success |
Renewal Opportunity Type of Subscribed Service
Sample:
renewal_opty_type_example
|
|
renewed_subscribed_service_id
string
|
on success |
SPM renewed Subscription ID
Sample:
ocid1.renewedsubscribedservice.oc1..xxxxxxEXAMPLExxxxxx
|
|
reseller_address
complex
|
on success |
|
|
|
bill_site_use_id
integer
|
on success |
Bill to site use Id.
Sample:
56
|
|
|
is_bill_to
boolean
|
on success |
Identify as the customer shipping address.
Sample:
True
|
|
|
is_ship_to
boolean
|
on success |
Identify as the customer invoicing address.
Sample:
True
|
|
|
location
complex
|
on success |
|
|
|
|
address1
string
|
on success |
Address first line.
Sample:
address1_example
|
|
|
|
address2
string
|
on success |
Address second line.
Sample:
address2_example
|
|
|
|
city
string
|
on success |
City.
Sample:
city_example
|
|
|
|
country
string
|
on success |
Country.
Sample:
country_example
|
|
|
|
postal_code
string
|
on success |
Postal code.
Sample:
postal_code_example
|
|
|
|
region
string
|
on success |
Region.
Sample:
us-phoenix-1
|
|
|
|
tca_location_id
integer
|
on success |
Region.
Sample:
56
|
|
|
name
string
|
on success |
Address name identifier.
Sample:
name_example
|
|
|
phone
string
|
on success |
Phone.
Sample:
phone_example
|
|
|
service2_site_use_id
integer
|
on success |
Service to site use Id.
Sample:
56
|
|
|
tca_cust_acct_site_id
integer
|
on success |
TCA customer account site Id.
Sample:
56
|
|
|
tca_party_site_number
string
|
on success |
Party site number.
Sample:
tca_party_site_number_example
|
|
reseller_contact
complex
|
on success |
|
|
|
email
string
|
on success |
Email.
Sample:
email_example
|
|
|
first_name
string
|
on success |
First name.
Sample:
first_name_example
|
|
|
last_name
string
|
on success |
Last name.
Sample:
last_name_example
|
|
|
name
string
|
on success |
Name.
Sample:
name_example
|
|
|
tca_contact_id
integer
|
on success |
TCA contact ID.
Sample:
56
|
|
|
tca_cust_accnt_site_id
integer
|
on success |
TCA customer account site ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
username
string
|
on success |
Username.
Sample:
username_example
|
|
reseller_customer
complex
|
on success |
|
|
|
customer_chain_type
string
|
on success |
Customer chain type.
Sample:
customer_chain_type_example
|
|
|
is_chain_customer
boolean
|
on success |
The business partner is chain customer or not.
Sample:
True
|
|
|
is_public_sector
boolean
|
on success |
The business partner is part of the public sector or not.
Sample:
True
|
|
|
name
string
|
on success |
Commercial name also called customer name.
Sample:
name_example
|
|
|
name_phonetic
string
|
on success |
Phonetic name.
Sample:
name_phonetic_example
|
|
|
tca_cust_account_number
string
|
on success |
TCA customer account number.
Sample:
tca_cust_account_number_example
|
|
|
tca_customer_account_id
integer
|
on success |
TCA customer account ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
tca_party_number
string
|
on success |
TCA party number.
Sample:
tca_party_number_example
|
|
revenue_line_id
integer
|
on success |
Subscribed service Revenue Line Id
Sample:
56
|
|
revenue_line_number
string
|
on success |
Revenue Line NUmber of Subscribed Service
Sample:
revenue_line_number_example
|
|
revised_arr_in_lc
string
|
on success |
Subscribed service Revised ARR
Sample:
revised_arr_in_lc_example
|
|
revised_arr_in_sc
string
|
on success |
Subscribed service Revised ARR in Standard Currency
Sample:
revised_arr_in_sc_example
|
|
sales_account_party_id
integer
|
on success |
Subscribed service sales account party id
Sample:
56
|
|
sales_channel
string
|
on success |
Sales Channel of Subscribed Service
Sample:
sales_channel_example
|
|
serial_number
string
|
on success |
Subscribed service line number
Sample:
serial_number_example
|
|
service_to_address
complex
|
on success |
|
|
|
bill_site_use_id
integer
|
on success |
Bill to site use Id.
Sample:
56
|
|
|
is_bill_to
boolean
|
on success |
Identify as the customer shipping address.
Sample:
True
|
|
|
is_ship_to
boolean
|
on success |
Identify as the customer invoicing address.
Sample:
True
|
|
|
location
complex
|
on success |
|
|
|
|
address1
string
|
on success |
Address first line.
Sample:
address1_example
|
|
|
|
address2
string
|
on success |
Address second line.
Sample:
address2_example
|
|
|
|
city
string
|
on success |
City.
Sample:
city_example
|
|
|
|
country
string
|
on success |
Country.
Sample:
country_example
|
|
|
|
postal_code
string
|
on success |
Postal code.
Sample:
postal_code_example
|
|
|
|
region
string
|
on success |
Region.
Sample:
us-phoenix-1
|
|
|
|
tca_location_id
integer
|
on success |
Region.
Sample:
56
|
|
|
name
string
|
on success |
Address name identifier.
Sample:
name_example
|
|
|
phone
string
|
on success |
Phone.
Sample:
phone_example
|
|
|
service2_site_use_id
integer
|
on success |
Service to site use Id.
Sample:
56
|
|
|
tca_cust_acct_site_id
integer
|
on success |
TCA customer account site Id.
Sample:
56
|
|
|
tca_party_site_number
string
|
on success |
Party site number.
Sample:
tca_party_site_number_example
|
|
service_to_contact
complex
|
on success |
|
|
|
email
string
|
on success |
Email.
Sample:
email_example
|
|
|
first_name
string
|
on success |
First name.
Sample:
first_name_example
|
|
|
last_name
string
|
on success |
Last name.
Sample:
last_name_example
|
|
|
name
string
|
on success |
Name.
Sample:
name_example
|
|
|
tca_contact_id
integer
|
on success |
TCA contact ID.
Sample:
56
|
|
|
tca_cust_accnt_site_id
integer
|
on success |
TCA customer account site ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
username
string
|
on success |
Username.
Sample:
username_example
|
|
service_to_customer
complex
|
on success |
|
|
|
customer_chain_type
string
|
on success |
Customer chain type.
Sample:
customer_chain_type_example
|
|
|
is_chain_customer
boolean
|
on success |
The business partner is chain customer or not.
Sample:
True
|
|
|
is_public_sector
boolean
|
on success |
The business partner is part of the public sector or not.
Sample:
True
|
|
|
name
string
|
on success |
Commercial name also called customer name.
Sample:
name_example
|
|
|
name_phonetic
string
|
on success |
Phonetic name.
Sample:
name_phonetic_example
|
|
|
tca_cust_account_number
string
|
on success |
TCA customer account number.
Sample:
tca_cust_account_number_example
|
|
|
tca_customer_account_id
integer
|
on success |
TCA customer account ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
tca_party_number
string
|
on success |
TCA party number.
Sample:
tca_party_number_example
|
|
sold_to_contact
complex
|
on success |
|
|
|
email
string
|
on success |
Email.
Sample:
email_example
|
|
|
first_name
string
|
on success |
First name.
Sample:
first_name_example
|
|
|
last_name
string
|
on success |
Last name.
Sample:
last_name_example
|
|
|
name
string
|
on success |
Name.
Sample:
name_example
|
|
|
tca_contact_id
integer
|
on success |
TCA contact ID.
Sample:
56
|
|
|
tca_cust_accnt_site_id
integer
|
on success |
TCA customer account site ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
username
string
|
on success |
Username.
Sample:
username_example
|
|
sold_to_customer
complex
|
on success |
|
|
|
customer_chain_type
string
|
on success |
Customer chain type.
Sample:
customer_chain_type_example
|
|
|
is_chain_customer
boolean
|
on success |
The business partner is chain customer or not.
Sample:
True
|
|
|
is_public_sector
boolean
|
on success |
The business partner is part of the public sector or not.
Sample:
True
|
|
|
name
string
|
on success |
Commercial name also called customer name.
Sample:
name_example
|
|
|
name_phonetic
string
|
on success |
Phonetic name.
Sample:
name_phonetic_example
|
|
|
tca_cust_account_number
string
|
on success |
TCA customer account number.
Sample:
tca_cust_account_number_example
|
|
|
tca_customer_account_id
integer
|
on success |
TCA customer account ID.
Sample:
56
|
|
|
tca_party_id
integer
|
on success |
TCA party ID.
Sample:
56
|
|
|
tca_party_number
string
|
on success |
TCA party number.
Sample:
tca_party_number_example
|
|
start_date_type
string
|
on success |
Subscribed service start date type
Sample:
start_date_type_example
|
|
status
string
|
on success |
Subscribed service status
Sample:
status_example
|
|
subscription_id
string
|
on success |
Subscription ID associated to the subscribed service
Sample:
ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx
|
|
subscription_source
string
|
on success |
Subscribed service source
Sample:
subscription_source_example
|
|
system_arr_in_lc
string
|
on success |
Subscribed service System ARR
Sample:
system_arr_in_lc_example
|
|
system_arr_in_sc
string
|
on success |
Subscribed service System ARR in Standard Currency
Sample:
system_arr_in_sc_example
|
|
system_atr_arr_in_lc
string
|
on success |
Subscribed service System ATR-ARR
Sample:
system_atr_arr_in_lc_example
|
|
system_atr_arr_in_sc
string
|
on success |
Subscribed service System ATR-ARR in Standard Currency
Sample:
system_atr_arr_in_sc_example
|
|
term_value
integer
|
on success |
Term value in Months
Sample:
56
|
|
term_value_uom
string
|
on success |
Term value UOM
Sample:
term_value_uom_example
|
|
time_agreement_end
string
|
on success |
Subscribed service agrrement end date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_created
string
|
on success |
Subscribed service creation date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_customer_config
string
|
on success |
Subscribed service customer config date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_end
string
|
on success |
Subscribed service end date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_majorset_end
string
|
on success |
Subscribed service Major Set End date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_majorset_start
string
|
on success |
Subscribed service Major Set Start date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_payment_expiry
string
|
on success |
Subscribed service payment expiry date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_provisioned
string
|
on success |
Subscribed service provisioning date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_service_configuration_email_sent
string
|
on success |
Subscribed service service configuration email sent date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_start
string
|
on success |
Subscribed service start date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
Subscribed service last update date
Sample:
2013-10-20T19:20:30+01:00
|
|
time_welcome_email_sent
string
|
on success |
Subscribed service welcome email sent date
Sample:
2013-10-20T19:20:30+01:00
|
|
total_value
string
|
on success |
Subscribed service total value
Sample:
total_value_example
|
|
transaction_extension_id
integer
|
on success |
Subscribed service Transaction Extension Id
Sample:
56
|
|
type
string
|
on success |
Subscribed Service line type
Sample:
type_example
|
|
updated_by
string
|
on success |
User that updated the subscribed service
Sample:
updated_by_example
|
|
used_amount
string
|
on success |
Subscribed service used amount
Sample:
used_amount_example
|