Skip to main content

Retrieve billing cycles

Find the details of scheduled payments and its billing cycles by sending a GET request to the /billingCycles endpoint.

You can use the following filters to customize your search as per your requirements:

Filters for retrieving a billing cycle
Filter Description
billingCycleStartDate Identifies the year, month and day when the first demand for payment (bill) is generated for the associated schedule.
billingCycleEndDate Designates the century, year, month, and day when the recurring billing will end . A billing cycle is a period of time determined by the billing frequency unit and billing frequency count as defined on the recurring plan. In this context, this is the last day of the current billing cycle.
billingCycleStatus Determines the current status of the billing schedule dependent on the payment processing outcome.
numberBillingCycles Designates the number of billing cycles to retrieve.
sortOrder

Codifies the direction in which the result set is displayed. Valid values are: 

  • ASC - Ascending order
  • DESC - Descending order
Note

Pagination is supported. By default, the page size (offSet) is 50.

HTTP method: GET

Endpoint: /billingCycles

Scenario: Retrieving billing cycles with billingCycleStatus = PENDING

Json
{
    "billingSchedules": [
        {
            "recurringProgramId": "9Yytu0mPKX",
            "merchantId": "998152096534",
            "consumerProfileId": "JPMCW-RRPUZB6PFUQNX4LW",
            "paymentMethodId": "7e3675ae-9f05-4fe9-bf7b-dcde57c1e4c0",
            "merchantRecurringProgramId": "YOUR_RECUR_PROG_ID_020",
            "planId": "vcTA8fn8Sl",
            "merchantPlanId": "YOUR_PLAN_ID_006",
            "planName": "Bronze Plan",
            "billingCycleSequenceNumber": "2",
            "billingCyclesTotalCount": 8,
            "billingCycleStartDate": "2024-05-29",
            "billingCycleEndDate": "2024-06-28",
            "billingDate": "2024-05-29",
            "billingScheduleAmount": 1100,
            "currencyCode": "USD",
            "pastDueAmount": 0,
            "creditAmount": 0,
            "totalRefundAmount": 0,
            "remainingRefundableAmount": 0,
            "additionalPaymentAmount": 0,
            "totalAmount": 1100,
            "billingScheduleStatus": "PENDING",
            "statusChangeDate": "2024-04-29T17:20:35.305287",
            "collectionMethod": "AUTOMATIC",
            "cyclePaymentStatus": "PENDING",
            "retriedCount": 0,
            "allowedRetryCount": 0,
            "paymentMethodType": {
                "ach": {
                    "financialInstitutionRoutingNumber": "122199983",
                    "last4AccountNumber": "9379",
                    "accountType": "CHECKING",
                    "maskedAccountNumber": "XXXXXXX9379"
                }
            }
        }
    ],
    "totalRetrieveRecordCount": 1
}