Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Name

Type

Description

id

String

The ID of the retrieved subscription

number

String

The number of the retrieved subscription

life_cycle_stateString

The subscription life cycle state which can be one of the following:

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

Tip

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

R17

R18.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)

Tip

Available from CRM.COM R9.0.0


rating_stateString

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

Tip

Available from CRM.COM R9.0.0


rated_up_toDate

The date up until which the subscription was rated.

Tip

Available from CRM.COM R12.1.0


freeBoolean

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

Tip

Available from CRM.COM R14.2.0


udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

accounts_receivableAccounts Receivable ObjectThe accounts receivable owning the subscription
pricing_agreement_price_planPrice Plan Object

The pricing agreement that was assigned against an Accounts Receivable

Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement)

Applicable for Accounts Receivables that are members in the related Corporate Account Group as well

Tip

Available from CRM.COM R14.0.0


Tip

From CRM.COM R15.0.0, pricing agreements are also available for accounts receivable owned by Person contact information


typeSubscription type objectThe subscription type of the retrieved subscription
billing_termsBilling terms objectThe billing terms of the retrieved subscription
subscription_addressAddress objectThe address denoting the location of the retrieved subscription
owned_by_groupGroup object

The group that is owning the subscription

Tip

Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)


owned_by_business_unitBusiness Unit Object

The business unit that is owning the subscription

Tip

Available from CRM.COM R18.0.0


privacy_levelPrivacy level object

The subscription's privacy level

Tip

Deprecated from CRM.COM R18.0.0


log_information

Log Information Object

The log information related with the retrieved subscription

walletWallet Object

The wallet related to the subscription, if the subscription is following a prepaid scheme

Tip

Available from CRM.COM R12.1.0

From CRM.COM R18.0.0, the wallet is returned for all subscriptions regardless of the billing model and as long as an effective wallet exists


usage_allowance_limitsUsage Allowance Limits Object

The usage allowance limits of the retrieved subscription.

Tip

Available from CRM.COM R18.0.0


termed_services_setSet of termed subscription service objectsThe termed subscription services of the retrieved subscription
one_time_services_setSet of one time subscription service objects

The one time subscription services of the retrieved subscription

Tip

Deprecated in CRM.COM R7.0.0


usage_services_set

Set of usage subscription service objects

The usage subscription services of the retrieved subscription

Tip

Deprecated in CRM.COM R7.0.0


installed_items_setSet of subscription installed item objectsThe subscription installed items of the retrieved subscription
termed_services_distribution_setSet of termed service distribution objects

The distribution of termed subscription services

Tip

Deprecated in CRM.COM R18.0.0


one_time_services_distribution_setSet of one time service distribution objects

The distribution of one time subscription services

Tip

Deprecated in CRM.COM R7.0.0


usage_services_distribution_setSet of usage service distribution objects

The distribution of usage subscription services

Tip

Deprecated in CRM.COM R7.0.0


installed_items_distribution_setSet of installed item distribution objects

The distribution of subscription installed items

Tip

Deprecated in CRM.COM R18.0.0


expense_services_setSet of expense subscription service objects

The expenses applied on the retrieved subscription

Tip

Available from CRM.COM R7.0.0


Anchor
subscription referred objects
subscription referred objects
Referred Objects Response Data

...

Include Page
log_information_short
log_information_short

Include Page
wallet_info_short
wallet_info_short

Include Page
usage_allowance_limits_short
usage_allowance_limits_short

Include Page
termed_subscription_service_short
termed_subscription_service_short

...

Include Page
free_subscription_service_short
free_subscription_service_short

Include Page
walletbusiness_infounit_shortwallet
business_infounit_short