SPCM subscriber plan CDR

The SPCM generates subscriber plan CDRs for events relating to subscriber plans such as plan purchases, plan activation or de-activation, and plan expiry.

Subsections include:

Field Name Description

1

Subscriber ID

The MSISDN of the subscriber in Tango format.

2

Service ID

The Tango CDR Service ID. This is 39 for subscriber plan CDRs.

3

Transaction Type

The CDR transaction type. This is 0 on a successful plan purchase.

For a complete list of transaction types, see Subscriber plan transaction types.

4

Tenant Id

Alphanumeric string that displays the ID of the network operator for which the CDR was produced.

5

CDR Generation Date

The date the CDR was generated. Format: DD/MM/YY.

6

CDR Generation Time

The time the CDR was generated. Format: hh:mm:ss.

7

Payment Type

The payment method used for the plan purchase.

possible values

  • -1 = unknown

  • 0 = prepaid

  • 1 = postpaid

8

Cost

The cost of a purchased plan.

This should only be set for transaction type 0 (successful plan purchase).

9

Plan Name

The name of the subscriber’s plan.

10

Plan Version

The version of the plan. The value of the field is a positive integer only.

11

Plan ID

The plan instance ID for the subscriber plan.

This can be a shared or individual plan depending on the Shared Plan Flag field.
The field is empty if inapplicable.

12

Plan Type

The plan type.

possible values

  • 0 = core plan

  • 1 = add-on

13

Plan Classification

The plan definition classification such as DATA.

14

Shared Plan Flag

A flag that indicates if a plan is shared.

possible values

  • 0 = not a shared plan

  • 1 = shared plan

15

Max Occurence Count

Indicates the number of times the plan is allowed to recur.

If set to 0 or if the fiels is empty, there is no limit on plan recurrence.

16

Plan Precedence

The plan precedence value where 0 is the highest precendence.

17

Plan State

The state of the subscriber’s plan.

possible values

  • 0 = inactive

  • 1 = charging

  • 2 = purchased

  • 3 = charging failed

  • 4 = active

  • 5 = expired

  • 6 = charging error

  • 7 = parked

  • 8 = refunded

  • 9 = refund deferred

  • 10 = terminated

If the field is blank, it is likely the plan has expired and/or has been removed from the database.

18

Plan Purchase Source

An indicator of the plan purchase source as provided by the SPCM web-service client.

format

<sourceType>-<sourceInfo>

example

pmi-admin = using PMI username as source info

This field is empty if not provided in the plan purchase.

19

Plan Purchase Date

The date of the plan purchase. Format: DD/MM/YYYY.

For recurring plans, this is the latest plan purchase date.

20

Plan Purchase Time

The time of the plan purchase. Format: hh:mm:ss.

For recurring plans, this is the latest plan purchase time.

21

Plan Activation Date

The date the plan was activated. Format: DD/MM/YYYY.

For recurring plans, this is the latest plan activation date.
The field is blank for transaction type 0.

22

Plan Activation Time

The time the plan was activated. Format: hh:mm:ss.

For recurring plans, this is the latest plan activation time.
The field is blank for transaction type 0.

23

Plan Expiry Date

The date the plan expires. Format: DD/MM/YYYY.

24

Plan Expiry Time

The time the plan expired. Format*: hh:mm:ss.

The field is empty if the plan expiry is unlimited.
The field is empty for transaction type 0.

25

Plan Deactivation Count

The number of times the plan has been deactivated.

26

Plan Recurrence Flag

The state of plan recurrence.

values

  • 0 = not recurring

  • 1 = recurring

27

Plan Recurrence Count

The number of times the plan has recurred.

28

Plan Metering Type

The plan metering type.

values

  • 0 = volume

  • 1 = time

29

Plan Limit

The maximum number of bytes or seconds of usage allowed for the plan. The Plan Metering Type field determines if this is in bytes or seconds.

The field displays -1 if not applicable.

30

Plan Purchase Type

The type of plan purchase.

possible values

  • 0 = normal plan purchase.

  • 1 = plan renewal (recurring renew plan)

  • 2 = plan accumulation (repurchase of existing plan - rolled to new instance)

  • 3 = pro-rata plan (applies to subscribers with fixed billing dates)

The field is empty if inapplicable.

31

Plan Limit Adjustments

The plan limit adjustment due to a plan purchase, renewal, or top-up.

The value here depends on the Plan Purchase Type field.
values

  • If type 0, this field is also 0.

  • If type 1, this field displays the rolled over usage amount.

  • If type 2, this field displays the plan limit increment due to accumulation.

  • If type 3, this field display the pro-rata adjustment amount.

If the Transaction Type is one of the following (19, 20, 21, 22), the field specifies the amount of the volume/validity booster. Check out [SPCM Subscriber Plan Transaction Types] for more details.

32

Discount Type

The type of discount applied to the plan.

options

  • 0 = none

  • 1 = fixed (e.g., meter rate from SPCM)

  • 2 = dynamic (e.g., rate from DPS)

33

Cancellation Cause

Explains why the plan was cancelled.

values

  • empty = plan not cancelled.

  • 0 = cancelled by subscriber.

  • 1 = cancelled because the renewal date changed for that plan.

  • 2 = cancelled because the validity of the plan was synchronised with a new plan purchase.

34

Number Validity Boosters

Specifies the number of validity boosters applied to the plan instance.

35

Number Volume Boosters

Specifies the number of volume boosters applied to the plan instance.

36

Booster Source

The source of the booster.

37

Booster Cost

The cost of the booster.

38

Plan Cost

The plan cost excluding VAT.

This is only present when the transaction type is 0.

39

VAT Rate

The VAT rate.

This is only present when the transaction type is 0.

40

Chargeable Subscriber

Denotes which subscribers may be charged.

values

  • 0 = if the subscriber was not charged for the plan.

  • 1 = if the subscriber was charged for the plan.

This will always be 1 if not a shared plan.
For shared plans, this will be 1 for the chargeable subscriber and 0 for other group members. This is only present when the transaction type is 0.

41

Purchase Tags

Displays the purchase tags by name and value.

format

name1=value1;name2=value2

This is only present when the transaction type is 0 or 1 - if tags were supplied.
Commas, equal signs, and semi-colons are percent-encoded if present in the name/value.

42

Loan Amount

Specifies the loan amount in the plan purchase request.

43

Validity Carry Forward Count

The count of the number of times a validity carry forward has occurred.

44

IMSI

The subscriber’s IMSI.

45

Unit Amount

The plan purchase unit amount. This overrides the plan definition unit amount (which is in bytes).

This field is optional and only used if set in the plan purchase.

46

Validity Period

The plan purchase validity period. This overrides the plan definition validity period.

This field is optional and only used if set in the plan purchase.

47

Transaction ID

Specifies a unique transaction ID generated by the SPCM when it purchases a plan and sends the direct debit request to the OCI server.

48

Charging Decision

Indicates whether charging is enabled for a plan. This field is optional and only present when the corresponding charging parameter is part of the plan purchase request API payload.

values

  • 0 = no charging; the plan definition is not chargeable

  • 1 = no charging; SPCM charging is disabled

  • 2 = no charging; plan instance charging is disabled

  • 3 = charging; SPCM charging is enabled

  • 4 = charging; plan instance charging is enabled

49

donor MSISDN

The MSISDN of the donor who shared quota with this subscriber.

This field is empty if nothing has been shared.

50

plan expiry reason

Specifies the reason for the plan expiring.

  • 0 = Expiry triggered by scheduled task based on the validity period.

  • 1 = Expiry triggered by usage report after expiry time.

  • 2 = Expiry triggered by plan accumulation after expiry time.

  • 3 = Expiry triggered by plan consumption.

This field is only relevant when the transaction type is 5 (plan expiry).

Subscriber plan transaction types

Type Description

0

Plan purchase successful.

Celebrate good times, c’mon!

1

Plan purchased failed.

2

Plan activated.

3

Plan deactivated.

4

Usage consumed

5

Plan expiry.

6

Plan cancelled.

7

Plan provisioning failure.

8

Plan terminated.

9

Plan volume top-up.

10

Plan validity period top-up.

11

Plan top up time.

12

Usage available.

13

Plan renewal parked.

14

Plan refunded.

15

Plan refund deferred.

16

Not in use.

17

Activation pending timeout.

This represents plans with an activation mode of FIRST_USAGE that have exceeded the plan activatin timeout period when waiting for a usage report.

18

Plan validity carried forward.

This transaction type is not created if the expiry timestamp of the current plan is after the newly-selected plan.

19

Plan volume has been boosted.

20

Plan validity has been boosted.

21

Failure to charge for the plan booster.

22

The plan booster charged successfully. However, the application of the booster failed.

Bummer, man.

23

Plan usage was reset.

24

Shared quota was deducted

25

Shared quota was rolled back.

26

Shared quota was added.

Subscriber Plan CDR Sample

SPCM Subscriber Plan sample
000410010203040506070801,39,0,VodafoneIE,05/11/2013,11:30:59,2,2300,PlanA,,1,0,,3,4,05/11/2013,11:30:59,05/11/2013,11:30:59,05/11/2013,11:35:59,0,0,0,0,2147483648,-1,,2,000410010203040506070802,