Subscriptions
Query Automated Recurring Billing (ARB) subscriptions for an Authorize.net merchant account.
View-Specific Information
The SearchType is the only available, supported column in the WHERE clause and it is required to retrieve results from Subscriptions. SearchType can be used with the (=) operator. Supported values are cardExpiringThisMonth, subscriptionActive, subscriptionExpiringThisMonth, and subscriptionInactive.
SELECT * FROM Subscriptions WHERE SearchType = 'subscriptionActive'
SELECT * FROM Subscriptions WHERE SearchType = 'subscriptionExpiringThisMonth'
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. | |
| SubscriptionId [KEY] | String | The payment gateway assigned identification number of the subscription. | |
| Name | String | Merchant-assigned name for the subscription. | |
| Status | String | The status of the subscription.
The allowed values are active, expired, suspended, canceled, terminated. | |
| CreatedTimeUTC | Datetime | The date and time the subscription was created, in UTC. | |
| FirstName | String | First name associated with the customer's billing address. | |
| LastName | String | Last name associated with the customer's billing address. | |
| TotalOccurrences | Integer | Number of billing occurrences or payments for the subscription. | |
| PastOccurrences | Integer | Number of billing occurrences or payments that have already been processed for the subscription. | |
| PaymentMethod | String | The payment method used for the subscription.
The allowed values are creditCard, eCheck, payPal. | |
| AccountNumber | String | The masked account number used for the subscription. | |
| Invoice | String | The invoice number associated with the subscription. | |
| Amount | Decimal | The amount billed to the customer for each payment. | |
| CurrencyCode | String | The currency code associated with the subscription amount. | |
| CustomerProfileId | Integer | The identifier of the customer profile associated with the subscription. | |
| CustomerPaymentProfileId | Integer | The identifier of the customer payment profile used for the subscription. | |
| CustomerShippingProfileId | Integer | The identifier of the customer shipping profile 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 |
| SearchType | String | The type of subscriptions to return. This filter is required.
The allowed values are cardExpiringThisMonth, subscriptionActive, subscriptionExpiringThisMonth, subscriptionInactive. |
| OrderBy | String | The field used to sort the returned subscriptions.
The allowed values are id, name, status, createTimeStampUTC, lastName, firstName, accountNumber, amount, pastOccurrences. |
| OrderDescending | Boolean | Whether the returned subscriptions are sorted in descending order of the OrderBy field. |