Product Offer and Bundle Management

The product offer management APIs include the messaging to activate, purchase, cancel, and modify catalog items. You can identify a product offer by its object ID or the external ID assigned during pricing plan creation.

The same product offer APIs are used to manage catalog items for product offers and bundles. The APIs use the same CatalogItemId to identify offers and bundles. You do not specify an object type (such as bundle).

Note:
To prevent bill shock, the PurchaseOffer and CancelOffer SubMan APIs can be called in advice mode (Advice of Charge) to estimate the cost of the purchase or cancelation. Response APIs describes the response SubMan APIs.
Table 1. Response APIs
Response Description
PurchaseOffer APIs When a PurchaseOffer SubMan API is called in advice mode, the response includes estimates for the purchase cost (charge and tax), any recurring charges, the amounts of granted assets, the cost of financing for a given down payment, including the principal amount financed, and the amount and number of installments in the finance contract offer.
CancelOffer APIs When a CancelOffer SubMan API is called in advice mode, the response includes estimates for the cancelation cost (charge and tax), the amount of the refund for any recurring charges, the amounts of forfeited assets, or the early termination charges in the finance contract.

Balance Information

When purchasing and canceling catalog items using the SubMan APIs, the SubMan API responses and notifications include a list of updated balances with the following information:
  • Balance ID
  • Owner ID
  • Balance validity
  • Type of balance (main balance, actual currency balance, or cost balance)
  • Total updated amount
  • Current amount
  • A list of update amounts and the update types:
    • 1 — Charge
    • 2 — Discount
    • 3 — Grant
    • 4 — Adjustment
    • 5 — Cancellation Refund
    • 6 — Cancellation Forfeiture
    • 7 — Forfeiture
    • 8 — Usage Refund
    • 9 — Transfer To
    • 10 — Transfer From
    • 11 — Rollover To
    • 12 — Rollover From
    • 13 — Payment
    • 14 — Tax
    • 15 — Cancellation Tax Refund
    • 16 — Usage Tax Refund
    • 17 — Recharge
    • 18 — Payment Refund
    • 19 — Late Charge
    • 20 — Early Termination Charge
    • 21 — Write-Off
    • 22 — Finance
    • 23 — Debt Payment
    • 25 — Tax Payment
    • 26 — Payment Tax Refund
    • 27 — Tax Paid Previously