Defining a Fixed Offset
When purchasing a catalog item that has a defined cycle, you can set a fixed offset for recurring processing. The offset is a specific week, month, or year.
To create a fixed offset, set the
CycleType
to fixed offset (5). The cycle is initiated on
the week, month, or year specified by the
CycleOffset
value.
The
CycleOffset
field in the SubMan request defines the
cycle offset. For example, assume a purchase request includes the following
MtxPurchasedItemCycleData definition:
<CycleData>
<MtxPurchasedItemCycleData>
<CycleType>5</CycleType>
<CycleResourceId>12345</CycleResourceId>
<CycleOffset>15</CycleOffset>
<CycleAlignmentDisabled>0</CycleAlignmentDisabled>
<ImmediateChange>1</ImmediateChange>
</MtxPurchasedItemCycleData>
</CycleData>
In this example, if the purchased item has a monthly cycle and an offset
of 15 is specified at purchase, the cycle will begin on the 15th day of the
month. Note that the
CycleAlignmentDisabled
value must be false when setting
a cycle offset.
Note: For weekly periods, the offset values are:
- Sunday (1)
- Monday (2)
- Tuesday (3)
- Wednesday (4)
- Thursday (5)
- Friday (6)
- Saturday (7)
For yearly periods, it is the day of year.