Additional Operations

Three-Step: Recurring

Add Plan XML Request

ElementDescription
<add-plan>Add a recurring plan that subscriptions can be added to in the future.
api-key*api-key is obtained in the Security Keys section of the Control Panel Settings.
<plan>
payments*The number of payments before the recurring plan is complete.
Notes: ‘0’ for until canceled
amount*The plan amount to be charged each billing cycle.
Format: x.xx
name*The display name of the plan.
plan-id*The unique plan ID that references only this recurring plan.
day-frequency**How often, in days, to charge the customer. Cannot be set with ‘month-frequency’ or ‘day-of-month’.
month-frequency***How often, in months, to charge the customer. Cannot be set with ‘day-frequency’. Must be set with ‘day-of-month’.
Values: 1 through 24
day-of-month***The day that the customer will be charged. Cannot be set with ‘day-frequency’. Must be set with ‘month-frequency’.
Values: 1 through 31 – for months without 29, 30, or 31 days, the charge will be on the last day
</plan>
</add-plan>
*Always required
**Required unless ‘month-frequency’ and ‘day-of-month’ is set.
***Required unless ‘day-frequency’ is set.

Delete a Subscription

ElementDescription
<delete-subscription>Delete the subscription. Customer will no longer be charged.
api-key*api-key is obtained in the Security Keys section of the Control Panel Settings.
subscription-id*The subscription ID that will be deleted.
</delete-subscription>
*Always required