Recurring Variables

Direct Post API

Add a Plan

Variable NameDescription
recurring*Add a recurring plan that subscriptions can be added to in the future.
Value: ‘add_plan’
plan_payments*The number of payments before the recurring plan is complete.
Notes: ‘0’ for until canceled
plan_amount*The plan amount to be charged each billing cycle.
Format: x.xx
plan_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
*Always required
**Required unless ‘month_frequency’ and ‘day_of_month’ is set.
***Required unless ‘day_frequency’ is set.

Add a Subscription to an Existing Plan

Variable NameDescription
recurring*Associate payment information with a recurring plan.
Value: add_subscription
plan_id*The plan ID of the plan that the subscription will be associated with.
start_dateThe first day that the customer will be charged.
Format: YYYYMMDD
ccnumber**Credit card number.
ccexp**Credit card expiration.
Format: MMYY
payment***The type of payment.
Default: ‘creditcard’
Values: ‘creditcard’ or ‘check’
checkname***The name on the customer’s ACH account.
checkaccount***The customer’s bank account number.
checkaba***The customer’s bank routing number.
account_type***The customer’s ACH account type.
Values: ‘checking’ or ‘savings’
account_holder_type***The customer’s ACH account entity.
Values: ‘personal’ or ‘business’
sec_codeACH standard entry class codes.
Values: ‘PPD’, ‘WEB’, ‘TEL’, or ‘CCD’
first_nameCardholder’s first name.
Legacy variable includes: firstname
last_nameCardholder’s last name.
Legacy variable includes: lastname
address1Card billing address.
cityCard billing city
stateCard billing state.
zipCard billing postal code.
countryCard billing country code.
phoneBilling phone number.
emailBilling email address.
companyCardholder’s company.
address2Card billing address, line 2.
faxBilling fax number.
orderidOrder ID
order_descriptionOrder Description
merchant_defined_field_#Can be set up in merchant control panel under ‘Settings’->’Merchant Defined Fields’.
ponumberCardholder’s purchase order number.
processor_idIf using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Load Balancing in the Control Panel).
customer_receiptIf set to true, when the customer is charged, they will be sent a transaction receipt.
Values: ‘true’ or ‘false’
*Always required
**Required unless ‘month_frequency’ and ‘day_of_month’ is set.
***Required unless ‘day_frequency’ is set.

Adding a Custom Subscription

Variable NameDescription
recurring*Add a custom recurring subscription that is NOT associated with an existing plan
Value: ‘add_subscription’
plan_payments*The number of payments before the recurring plan is complete.
Notes: ‘0’ for until canceled
plan_amount*The plan amount to be charged each billing cycle.
Format: x.xx
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
start_dateThe first day that the customer will be charged.
Format: YYYYMMDD
ccnumber****Credit card number.
ccexp****Credit card expiration.
Format: MMYY
paymentThe type of payment.
Default: ‘creditcard’
Values: ‘creditcard’ or ‘check’
checknameThe name on the customer’s ACH account.
checkaccountThe customer’s bank account number.
checkabaThe customer’s bank routing number.
account_typeThe customer’s ACH account type.
Values: ‘checking’ or ‘savings’
account_holder_typeThe customer’s ACH account entity.
Values: ‘personal’ or ‘business’
sec_codeACH standard entry class codes.
Values: ‘PPD’, ‘WEB’, ‘TEL’, or ‘CCD’
first_nameCardholder’s first name.
Legacy variable includes: firstname
last_nameCardholder’s last name.
Legacy variable includes: lastname
address1Card billing address.
cityCard billing city
stateCard billing state.
zipCard billing postal code.
countryCard billing country code.
phoneBilling phone number.
emailBilling email address.
companyCardholder’s company.
address2Card billing address, line 2.
faxBilling fax number.
orderidOrder ID
order_descriptionOrder Description
Legacy variable includes: orderdescription
merchant_defined_field_#Can be set up in merchant control panel under ‘Settings’->’Merchant Defined Fields’.
ponumberCardholder’s purchase order number.
processor_idIf using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Load Balancing in the Control Panel).
customer_receiptIf set to true, when the customer is charged, they will be sent a transaction receipt.
Values: ‘true’ or ‘false’
*Always required
**Required unless ‘month_frequency’ and ‘day_of_month’ is set.
***Required unless ‘day_frequency’ is set.
****Required for credit card transactions
Required for ACH transactions

Update a Subscription’s Billing Information

Variable NameDescription
recurring*Update the subscription’s billing information.
Value: ‘update_subscription’
subscription_id*The subscription ID that will be updated.
*Always Required

Delete a Subscription

Variable NameDescription
recurring*Delete the subscription. Customer will no longer be charged.
Value: ‘delete_subscription’
subscription_id*The subscription ID that will be deleted.
*Always Required