SubscriptionDetails
Query the details of an Automated Recurring Billing (ARB) subscription for an Authorize.net merchant account.
View-Specific Information
The SubscriptionId is the only required column in the WHERE clause to retrieve results from SubscriptionDetails and can be used with the (=) operator. You can optionally set IncludeTransactions to true to include the transactions associated with the subscription in the response.
SELECT * FROM SubscriptionDetails WHERE SubscriptionId = '100748'
SELECT * FROM SubscriptionDetails WHERE SubscriptionId = '100748' AND IncludeTransactions = true
SubscriptionDetails returns the full subscription profile, including the payment method, billing address, shipping address, and order information. The payment columns depend on how the subscription was funded: the CardNumber, CardType, and ExpirationDate columns are populated for credit card subscriptions, while the BankAccountType, BankRoutingNumber, BankAccountNumber, NameOnAccount, EcheckType, and BankName columns are populated for bank account (eCheck) subscriptions. Only one payment method applies to a given subscription, so the columns for the other method are null.
When IncludeTransactions is set to true, the ArbTransactions column contains a JSON array of the transactions associated with the subscription. Each element includes the TransId, Response, SubmitTimeUTC, PayNum, and AttemptNum values. The Authorize.net API returns at most the 20 most recent transactions.
Columns
| Name | Type | Statistic | Description |
| RefId | String | Merchant-assigned reference ID for the request. If a value is supplied in the filter, that value is returned in the response. | |
| SubscriptionName | String | Merchant-assigned name for the subscription. | |
| IntervalLength | Integer | The measurement of time, in association with IntervalUnit, that defines the frequency of the billing occurrences. | |
| IntervalUnit | String | The unit of time between billings.
The allowed values are days, months. | |
| StartDate | Date | The date the subscription began. This is also the date the initial billing occurred. | |
| TotalOccurrences | Integer | Number of billing occurrences or payments for the subscription. | |
| TrialOccurrences | Integer | Number of billing occurrences or payments in the trial period. | |
| Amount | Decimal | The amount billed to the customer for each payment. | |
| TrialAmount | Decimal | The amount charged for each payment during the trial period. | |
| Status | String | The status of the subscription.
The allowed values are active, expired, suspended, canceled, terminated. | |
| MerchantCustomerId | String | The merchant-assigned identifier for the customer associated with the subscription. | |
| CustomerDescription | String | The description of the customer profile associated with the subscription. | |
| CustomerEmail | String | The email address associated with the customer profile. | |
| CustomerProfileId | String | The identifier of the customer profile associated with the subscription. | |
| CustomerType | String | The type of customer associated with the payment profile.
The allowed values are individual, business. | |
| BillToFirstName | String | First name associated with the customer's billing address. | |
| BillToLastName | String | Last name associated with the customer's billing address. | |
| BillToCompany | String | Company associated with the customer's billing address. | |
| BillToAddress | String | Street address of the customer's billing address. | |
| BillToCity | String | City of the customer's billing address. | |
| BillToState | String | State of the customer's billing address. | |
| BillToZip | String | ZIP code of the customer's billing address. | |
| BillToCountry | String | Country of the customer's billing address. | |
| BillToPhoneNumber | String | Phone number associated with the customer's billing address. | |
| BillToFaxNumber | String | Fax number associated with the customer's billing address. | |
| BillToEmail | String | Email address associated with the customer's billing address. | |
| CustomerPaymentProfileId | String | The identifier of the customer payment profile used for the subscription. | |
| DefaultPaymentProfile | Boolean | Whether the payment profile is the default payment profile for the customer profile. | |
| CardNumber | String | The masked credit card number used for the subscription. | |
| ExpirationDate | String | The masked expiration date of the credit card used for the subscription. | |
| CardType | String | The type of credit card used for the subscription. | |
| CardArtCardBrand | String | The card brand reported in the card art details of the credit card. | |
| CardArtCardImageHeight | String | The height of the card art image for the credit card. | |
| CardArtCardImageUrl | String | The URL of the card art image for the credit card. | |
| CardArtCardImageWidth | String | The width of the card art image for the credit card. | |
| CardArtCardType | String | The card type reported in the card art details of the credit card. | |
| IssuerNumber | String | The issuer identification number of the credit card. | |
| IsPaymentToken | Boolean | Whether the card number represents a payment token rather than an actual credit card number. | |
| BankAccountType | String | The type of bank account used for the subscription.
The allowed values are checking, savings, businessChecking. | |
| BankRoutingNumber | String | The masked routing number of the bank account used for the subscription. | |
| BankAccountNumber | String | The masked account number of the bank account used for the subscription. | |
| NameOnAccount | String | The name of the account holder for the bank account used for the subscription. | |
| EcheckType | String | The type of electronic check transaction used for the subscription.
The allowed values are PPD, WEB, CCD, TEL, ARC, BOC. | |
| BankName | String | The name of the bank associated with the bank account used for the subscription. | |
| TokenSource | String | The source of the payment token used for the subscription. | |
| TokenNumber | String | The masked token number used for the subscription. | |
| TokenExpirationDate | String | The masked expiration date of the payment token used for the subscription. | |
| TokenRequestorId | String | The identifier of the requestor of the payment token. | |
| DriversLicenseNumber | String | The masked driver's license number of the customer. | |
| DriversLicenseState | String | The state that issued the customer's driver's license. | |
| DriversLicenseDateOfBirth | String | The date of birth listed on the customer's driver's license. | |
| TaxId | String | The masked tax identification number of the customer. | |
| SubscriptionIds | String | The identifiers of the subscriptions associated with the payment profile. | |
| OriginalNetworkTransId | String | The network transaction identifier of the original transaction for the payment profile. | |
| OriginalAuthAmount | Decimal | The amount of the original authorization for the payment profile. | |
| ExcludeFromAccountUpdater | Boolean | Whether the payment profile is excluded from the Account Updater service. | |
| ShipToFirstName | String | First name associated with the customer's shipping address. | |
| ShipToLastName | String | Last name associated with the customer's shipping address. | |
| ShipToCompany | String | Company associated with the customer's shipping address. | |
| ShipToAddress | String | Street address of the customer's shipping address. | |
| ShipToCity | String | City of the customer's shipping address. | |
| ShipToState | String | State of the customer's shipping address. | |
| ShipToZip | String | ZIP code of the customer's shipping address. | |
| ShipToCountry | String | Country of the customer's shipping address. | |
| ShipToPhoneNumber | String | Phone number associated with the customer's shipping address. | |
| ShipToFaxNumber | String | Fax number associated with the customer's shipping address. | |
| ShipToEmail | String | Email address associated with the customer's shipping address. | |
| CustomerAddressId | String | The identifier of the customer's shipping address. | |
| OrderInvoiceNumber | String | The merchant-assigned invoice number associated with the subscription order. | |
| OrderDescription | String | The description of the subscription order. | |
| ArbTransactions | String | A JSON aggregate of the transactions associated with the subscription, |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| SubscriptionId | String | The payment gateway assigned identification number of the subscription. This filter is required. |
| IncludeTransactions | Boolean | Whether to include the transactions associated with the subscription in the response. |