Creating and Changing Billing Cycles
Using the SubMan APIs, you can set parameters that affect the billing cycle.
DateOffset
— The offset within the billing period if theBillingDatePolicy
has a specific offset value. If not present, then the start of the billing period is used.ImmediateChange
— Applies only when the billing cycle is changed. Set the value to true to have the change take effect in the current period. This option is applicable for period types weekly, monthly, and yearly.Depending on the new offset and the day when the change request is made, the current period could be terminated on the day before the new offset, and the next period starts on the new offset. Or, the current period is not terminated, but the next period is a short period, ending on the new offset.
For more information about billing cycles, see the discussion about billing cycles in MATRIXX Pricing and Rating.
When a billing cycle is changed, an MtxBillingCycleChangeEvent Event Detail Record (EDR) is generated. If the current cycle is shortened, an
MtxPeriodTerminationEvent EDR is generated. The period termination proration policy defined in product offer cycle data is applied to generate refunds and forfeitures for the terminated
period. If the CycleType
is 3 (purchased item cycle), information about the purchased item, offer, or bundle is included in the OfferInfoArray
or
BundleInfoArray
, respectively. If the purchased item is a bundle, information for all offers in the bundle is included in the OfferInfoArray
. For
information about MtxBillingCycleChangeEvent, see MATRIXX Integration.
- SubscriptionCreate (POST /subscription)
- GroupCreate (POST /group)
- SubscriptionModify (PUT /subscription)
- GroupModify (PUT /group)