Transaction Types and Uses

The table below provides information about the various Recurring Engine transaction types and their uses.

TABLE 1-6 Recurring Engine Transaction Types

Use Case/Intent

Parent Element

Description/Uses

Create Plan

createPlan

Used to create new Plans.

Update Plan

updatePlan

Used to toggle a Plan between an active and inactive state. You can not associate an inactive Plan with a Subscription.

Toggling a Plan to an inactive state does not affect existing Subscriptions associated with the Plan.

Create Subscription

<authorization> or <sale>

<recurringRequest>

<subscription>

Used to initiate a Subscription with an associated Plan. The Subscription can include amount and numberOfPayment overrides to the Plan. Also, the Subscription can include createAddOn and createDiscount children.

Update Subscription

updateSubscription

Used to modify Subscription information including: changing the Plan, changing the billing name/address, and changing the method of payment. You can also use this transaction type to create/delete/update Add Ons and Discounts.

Cancel Subscription

cancelSubscription

Used to cancel an existing Subscription.

Create Add On

<authorization> or <sale>

<recurringRequest>

<subscription>

<createAddOn>

Or

<updateSubscription>

<createAddOn>

Used to create an Add On charge associated with the Subscription.

 

Update Add On

<updateSubscription>

<updateAddOn>

Used to modify one or more of the parameters associated with the Add On.

 

Delete Add On

<updateSubscription>

<deleteAddOn>

Used to delete an Add On charge from the associated Subscription.

Create Discount

<authorization> or <sale>

<recurringRequest>

<subscription>

<createDiscount>

Or

<updateSubscription>

<createDiscount>

Used to create a Discount charge associated with the Subscription.

Update Discount

<updateSubscription>

<updateDiscount>

Used to modify one or more of the parameters associated with the Discount.

Delete Discount

<updateSubscription>

<deleteDiscount>

Used to delete a Discount from the associated Subscription.