Recurring Program Next Billing report
This report provides both summary and detailed views at the recurring program level. It can be used to identify all active profiles, profiles with suspended payment methods, and profiles with cards expiring prior to the next billing date.
| Report type | Supported entity types | Supported file formats |
|---|---|---|
| Managed Billing |
|
|
Use cases
- Provides both summary and detailed information at the recurring program level.
- Provides identification of all active profiles, profiles with suspended payment methods, and profiles with cards expiring before the next billing date.
Granularity
- Summary section: Combination of Plan Name, Plan ID , Recurring program Status, Number of Unique Recurring Programs, Currency and Total Billing Amount.
- Details section: Combination of both Consumer profiles ID and status along with recurring plan details.
Fields
Summary
The following table shows the summary section field details.
| Field name | Description |
|---|---|
Record Type |
The section of the report. For the summary section, record type value is MBR0010. |
Plan Name |
The label for a payment program or contract offered by the merchant for products or services that include product pricing and billing frequency. |
Plan ID |
Unique identifier for a payment program or contract managed by the Firm on behalf of the merchant for products or services that include product pricing and billing frequency. |
Recurring Program Status |
The current standing of a recurring payment program (subscription) by the merchant's consumer for products or services offered by merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Number of Unique Profiles |
Identifies a unique occurrence of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant to processing transactions such as name, address, account and potentially information for multiple payment methods. |
Number of Unique Recurring Programs |
The firm generated identifier that connects a merchant's consumer to products/services offered by the merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Currency |
Represents a unique identifier for currencies, as assigned by the ISO 4217 specification. Alternatively, a currency code may also be a custom firm assigned value created where an ISO code does not exist. In this instance, the currency of the representment is being referenced. |
Total Billing Amount |
The monetary value for the portion of the total bill that is expected for corresponding billing cycle (time interval) represented by the Billing Amount Billing Period Type Code. |
Details
The following table shows the details section field details.
| Field name | Description |
|---|---|
Record Type |
The section of the report. For the detail section, record type value is MBR0010. |
Transaction Processing Entity Identifier |
Unique entity identifier for transaction processing at the lowest level of the account hierarchy of the Firm's microservices Application Program Interface (API) and events based payment processing platform that supports domestic and international merchants. This level organizes transaction types for submission, funding, and reporting. |
Consumer Profile ID |
Unique identifier of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant to processing transactions such as name, address, account and potentially information for multiple payment methods. |
Processor Profile ID |
Unique identifier of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant to processing transactions such as name, address, account and potentially information for multiple payment methods. In this case, the identifier was assigned by the Firm's Client Profile System (CPS). |
Consumer Profile Status |
The current standing of a consumer's information maintained by the Firm on behalf of the merchant. |
Customer Name |
The individual's full name. In this instance this is the full name of the consumer account. |
Customer Email |
The location in a mail system that allows a party to send and receive messages electronically. It is composed of a local part and domain part. The local part is unique within the mail domain while the domain part or host name must meet specific standards. In this instance Consumer account profile is referred to as Party. |
Customer Address |
The portion of a party's address that is the line of the unstructured (unparsed) geographic street address, containing any of the following: house number, street name, street direction, street type, dwelling type and number, post office box number, rural delivery route number, In Care Of. In this case party is the consumer in the first line of their address. |
Payment Method ID |
Unique identifier of the type of payment accepted by a level of the hierarchy of the merchant acquiring account. |
Payment Method Code |
The method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: Visa, MasterCard, PayPal, Bill Me Later etc. Also known with the Firm as method of payment or MOP. |
Account Number |
Unique number of a financial account as assigned by the system of record when the account is created. This element includes the account number or loan number as presented to the customer. |
Payment Method Status |
The current standing of the account assigned to a monetary instrument (such as a Card, Direct Debit Account(DDA) or other payment account identifier provided for alternative method of payment or local payment solution) sent to the merchant acquirer to facilitate payment for the exchange of goods and services in a financial transaction. In this instance it codifies the current status of the card. Sample Values: ACTIVE : ACTIVE, INACTIVE : INACTIVE, PENDING : PENDING, ERRORED : ERRORED, SUSPENDED : SUSPENDED, VERIFICATION_FAILED : VERIFICATION_FAILED. |
Card Expiration Date |
A number in the form of Month/Year that is displayed on a card (Debit/Credit). This number is used for the date which is no longer in effect for transactions being processed at the Point of Sale. |
Recurring Program ID |
The firm generated identifier that connects a merchant's consumer to products/services offered by the merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Merchant Recurring Program ID |
A merchant generated identifier that connects a merchant's consumer to products/services offered by the merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Recurring Program Status Code |
The current standing of a recurring payment program (subscription) by the merchant's consumer for products or services offered by merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Plan Name |
The label for a payment program or contract offered by the merchant for products or services that include product pricing and billing frequency. |
Plan ID |
Unique identifier for a payment program or contract managed by the Firm on behalf of the merchant for products or services that include product pricing and billing frequency. |
Next Billing Date |
The year, month and day when the first demand for payment (bill) is generated for the associated schedule. |
Currency |
Represents a unique identifier for currencies, as assigned by the ISO 4217 specification. Alternatively, a currency code may also be a custom firm assigned value created where an ISO code does not exist. In this instance, the currency of the representment is being referenced. |
Next Billing Amount |
The monetary value for the portion of the total bill that is expected for corresponding billing cycle (time interval) represented by the Billing Amount Billing Period Type Code. |
Card Expire Indicator |
Indicates whether the card's expiration date comes before the next billing date for associated recurring program. Valued values are:
|
Sample report configurations
The following samples help you get an idea of how to configure closed batch summary reports.
CO/BU/TD/PE
The following request code block shows how to configure an account updated report for entityType = CO/BU/TD/PE.
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Managed Billing",
"sectionReportTypeId": "3020",
"sectionTitle": "Recurring Program Next Billing Summary",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "MBR0010"
},
{
"alias": "Plan Name",
"reportAttributeName": "Merchant Recurring Plan Name"
},
{
"alias": "Plan ID",
"reportAttributeName": "Recurring Plan Identifier"
},
{
"alias": "Recurring Program Status",
"reportAttributeName": "Recurring Program Status Code"
},
{
"alias": "Number of Unique Profiles",
"reportAttributeName": "Consumer Profile Identifier",
"aggregateOperationText": "distinctCount"
},
{
"alias": "Number of Unique Recurring Programs",
"reportAttributeName": "Recurring Program Identifier",
"aggregateOperationText": "distinctCount"
},
{
"alias": "Currency",
"reportAttributeName": "Representment Currency Code"
},
{
"alias": "Total Billing Amount",
"reportAttributeName": "Billing Period Type Scheduled Payment Amount",
"aggregateOperationText": "sum"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Report Type Name",
"filterAttributeCode": "IN (\"RECURRING\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Merchant Recurring Plan Name",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Recurring Program Status Code",
"sortOrderCode": "asc"
}
]
},
{
"sectionReportTypeName": "Managed Billing",
"sectionReportTypeId": "3020",
"sectionTitle": "Recurring Program Next Billing Details",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "MBR0010"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"alias": "Consumer Profile ID",
"reportAttributeName": "Consumer Profile Identifier"
},
{
"alias": "Processor Profile ID",
"reportAttributeName": "Internal Consumer Profile Identifier"
},
{
"alias": "Consumer Profile Status",
"reportAttributeName": "Consumer Profile Status Code"
},
{
"alias": "Customer Name",
"reportAttributeName": "Consumer Name"
},
{
"alias": "Customer Email",
"reportAttributeName": "Consumer Profile Email Address Text"
},
{
"alias": "Customer Address",
"reportAttributeName": "Consumer Address"
},
{
"alias": "Payment Method ID",
"reportAttributeName": "Payment Method Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"alias": "Payment Account Number",
"reportAttributeName": "Masked Account Number"
},
{
"alias": "Payment Method Status",
"reportAttributeName": "Payment Method Account Status Code"
},
{
"alias": "Card Expiration Date",
"reportAttributeName": "Card Expiration Month Year Number"
},
{
"alias": "Recurring Program ID",
"reportAttributeName": "Recurring Program Identifier"
},
{
"alias": "Merchant Recurring Program ID",
"reportAttributeName": "Merchant Recurring Program Identifier"
},
{
"reportAttributeName": "Recurring Program Status Code"
},
{
"alias": "Plan Name",
"reportAttributeName": "Merchant Recurring Plan Name"
},
{
"alias": "Plan ID",
"reportAttributeName": "Recurring Plan Identifier"
},
{
"alias": "Next Billing Date",
"reportAttributeName": "Billing Schedule Date"
},
{
"alias": "Currency",
"reportAttributeName": "Representment Currency Code"
},
{
"alias": "Next Billing Amount",
"reportAttributeName": "Billing Period Type Scheduled Payment Amount"
},
{
"reportAttributeName": "Card Expire Indicator"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Report Type Name",
"filterAttributeCode": "IN (\"RECURRING\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Merchant Recurring Plan Name",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Recurring Program Status Code",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Recurring Program Next Billing Report",
"reportFileName": "Recurring Program Next Billing Report.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,GenerationTime=<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2025-06-03 00:00:00",
"reportingPeriodEndTimestamp": "2025-06-04 00:00:00"
}
}