Recurring Billing
Recurring billing cycle
A recurring billing cycle provides visibility into the individual billing events generated for a recurring payment. Use these endpoints to retrieve billing cycle details, monitor payment and retry activity, manage billing cycle status, manually collect past-due payments, and issue full or partial refunds when needed.
A cycle contains:
- Scheduled date
- Billing period
- Amounts
- Retry information
- Refund information
- Collection status
Billing cycle endpoints
Billing cycles are managed through the following endpoints:
| Endpoint | Description | Use cases |
|---|---|---|
GET /recurring-payments/{recurringPaymentId}/billing-cycles |
Retrieves billing cycles associated with a recurring payment. The response includes billing cycle details, statuses, payment outcomes, retry information, and amounts. |
|
GET /recurring-payments/{recurringPaymentId}/billing-cycles/{billingCycleId} |
Retrieves details for a specific billing cycle. The response includes schedule information, amounts, retry activity, payment status, and transaction references. | Investigate billing issues, review cycle activity, analyze payment results, verify refund eligibility. |
POST /recurring-payments/{recurringPaymentId}/billing-cycles/{billingCycleId}/actions |
Performs lifecycle actions on an existing billing cycle. Supported actions include SKIP, ROLLOVER, RESCHEDULE, and RESUME. |
Skip a scheduled charge, carry outstanding balances into a future cycle, and resume a previously skipped cycle. |
POST /recurring-payments/{recurringPaymentId}/billing-cycles/{billingCycleId}/collections |
Manually initiates collection for a past-due, failed, or eligible scheduled billing cycle using a payment method associated with the consumer profile. | Recover delinquent payments, collect overdue balances, process consumer-requested payments. |
POST /recurring-payments/{recurringPaymentId}/billing-cycles/{billingCycleId}/refunds |
Processes a full or partial refund for a paid billing cycle. | Issue consumer refunds, correct billing errors, apply service credits or adjustments. |