Renewal

A renewal represents one specific cycle within a renewal group. It defines the validity period of the prepaid product (e.g., one month), its current status, and the associated product it renews.

Each renewal belongs to exactly one renewal group, and its lifecycle is managed according to the group’s renewal schedule.

Renewal Lifecycle

Managing Renewals and the Renewal Lifecycle

B) Before the renew action is called on the renewal group, it’s possible to transition renewals between the pending and disabled states. This allows partners to control which products will be renewed once the renew action is executed.
C) When the renew action is called, all pending renewals are transitioned to the scheduled state.
D) While a renewal is in the scheduled state, it can be canceled. This action is irreversible, and a new product would need to be purchased later.
E) At the end of the cycle, all scheduled renewals transition to the completed state, and new pending renewals are created.
F) At the end of the cycle, all disabled and pending renewals transition to the terminated state.

API Reference

See the full list of endpoints, request and response schemas, examples, and version information in the Renewals section of the API Reference.