Order subscription items

The order subscription item object and the allowed CRUD operations on the related resource endpoint

Order subscription items can be of type skus, bundles, or adjustments and are used to generate the target order's line items involved in the automatic order subscriptions generation using recurring order copies. Order subscription items are automatically generated from the source order's line items with frequency, according to the strategy set at the subscription model level:

  • by_frequency — for each automatically generated order subscription as many order subscription items as the source order’s line items that have that specific frequency will be generated.

  • by_line_items — for each automatically generated order subscription one order subscription item only will be generated.

Like line items, order subscription items have a quantity and a unit price — both inherited from the source order's line items — that can be changed anytime by updating the order subscription item itself to customize the generated target order's line items. If the source order's line items unit price is computed according to a price frequency tier, any change to the tier itself that happens after the order subscription item generation won't be reflected on the order subscription item unit price.

Data model

Check the related ER diagram and explore the flowchart that illustrates how the order subscription item resource relates to the other API entities.

How-to

Check the related guide to learn more about how to generate and automatic subscriptions from a source order and how to add, remove, or update order subscription items belonging to an already generated order subscription.

Last updated