Skip to main content
Version: 1.26 (Current)

Create Subscription

Authorize.Net create a recurring subscription. To use actions list for webhook notifications please follow the instructions here to set up your notifications Your webhook endpoint url is: "{YourSiteUrl}/DesktopModules/DnnSharp/Common/WebHandlers/AuthorizeCreateSubscriptionHandler.ashx"

Parameter Reference

ParameterDescriptionSupports TokensDefault
API Login IDAPI Login ID and Transaction Key. These keys will authenticate requests to the payment gateway. Can contain My Tokens.YesNone
Transaction KeyAPI Login ID and Transaction Key. These keys will authenticate requests to the payment gateway. Can contain My Tokens.YesNone
Go LiveEnable this option to switch to Live Mode. By default, unchecked, Test Mode, the transaction will be posted to the Authorize.Net's test server.NoNone
Card NumberCredit card number. Can contain My Tokens.YesNone
Card CCVCredit card CCV. Can contain My Tokens.YesNone
Subscription NameName of the subscription. Can contain My Tokens.YesNone
Subscription AmountAmount of the subscription. This is the total amount and must include tax, shipping, and any other charges. Up to 15 digits with a decimal point (no dollar symbol. For example, 8.95. Can contain My Tokens.YesNone
Subscription Trial AmountOptional. Amount of the trial subscription. This is the total amount and must include tax, shipping, and any other charges. Up to 15 digits with a decimal point (no dollar symbol. For example, 8.95. Can contain My Tokens.YesNone
Expiration MonthCredit card expiration month. Can contain My Tokens.YesNone
Expiration YearCredit card expiration Year. Can contain My Tokens.YesNone
Interval LengthSubscription interval length. The interval length must be 7 to 365 days or 1 to 12 months. Can contain My Tokens.YesNone
Interval UnitSubscription interval unit. Days or Months. Can contain My Tokens.Yes0
Total OccurrencesTotal number of occurrences of the subscription. Number of billing occurrences or payments for the subscription. To submit a subscription with no end date (an ongoing subscription), this field must be submitted with a value of 9999. If a trial period is specified, this number should include the trial occurrences. Can contain My Tokens.YesNone
Trial OccurrencesOptional. Number of occurrences for the trial period of the subscription. If a trial period is specified, this number should include the trial occurrences. Can contain My Tokens.YesNone
First NameFirst name of the subscription profile. Can contain My Tokens.YesNone
Last NameLast name of the subscription profile. Can contain My Tokens.YesNone
CountryOptional. Country of the subscription profile. Can contain My Tokens.YesNone
StateOptional. State of the subscription profile. Can contain My Tokens.YesNone
CityOptional. City of the subscription profile. Can contain My Tokens.YesNone
AddressOptional. Address of the subscription profile. Can contain My Tokens.YesNone
Postal CodeOptional. Postal Code of the subscription profile. Can contain My Tokens.YesNone
CompanyOptional. Company of the subscription profile. Can contain My Tokens.YesNone
Response Result Code TokenNameOptionally provide a token name where to store the result code.NoNone
Response Message TokenNameOptionally provide a token name where to store the response message.NoNone
Response SubscriptionId TokenNameOptionally provide a token name where to store the subscription id.NoNone
Response Customer ProfileId TokenNameOptionally provide a token name where to store the customer profile id.NoNone
Response Customer PaymentProfileId TokenNameOptionally provide a token name where to store the customer payment profile id.NoNone
Response Customer Address Id TokenNameOptionally provide a token name where to store the customer address id.NoNone
Response Ref Id TokenNameOptionally provide a token name where to store the ref Id.NoNone
Response SessionToken TokenNameOptionally provide a token name where to store the session token.NoNone
On SuccessDefine a list of actions that should execute when a transaction is successfully created.NoNone
On ErrorDefine a list of actions that should execute when this action's result is Error.NoNone
On Subscription Payment CreatedDefine a list of actions to be executed when Authorize.Net notifies you that a subscription has been created.NoNone
On Subscription Payment UpdatedDefine a list of actions to be executed when Authorize.Net notifies you that a subscription has been updated.NoNone
On Subscription Payment SuspendedDefine a list of actions to be executed when Authorize.Net notifies you that a subscription has been suspended.NoNone
On Subscription Payment TerminatedDefine a list of actions to be executed when Authorize.Net notifies you that a subscription has been terminated.NoNone
On Subscription Payment CancelledDefine a list of actions to be executed when Authorize.Net notifies you that a subscription has been cancelled.NoNone
On Subscription Payment ExpiringDefine a list of actions to be executed when Authorize.Net notifies you when a subscription has only one recurrence left to be charged.NoNone