API Reference

This is the introduction section of the API scope related to recurrences on the platform. With it, you can create monthly (recurring) plan charges for users of your platform through the Recurrence Creation endpoint or the Recurrence Link Creation endpoint.

Typically, platforms offering plans, monthly fees, and subscriptions utilize this payment approval model, where the first payment is made by the buyer and subsequent payments are automatically processed and authorized according to the flow/method chosen by the establishment. Below are the recurrence modalities supported by our platform.

Standard Recurrence

This is the modality of recurrence where the recurrence occurs and is applied until the recurrence is canceled; it will continue to occur until it is necessary unless the customer or establishment cancels the recurrence at some point.

Recurrence Until a Date

This is the modality of recurrence where the recurrence occurs until a specified end date is reached. Typically, these are recurrences used by platforms that offer licenses to use a service until a certain time through monthly payments.

Recurrence Until Number of Installments

This is a modality where the recurrence occurs until a specified number n of times, meaning that as long as that established quantity is not exceeded, the recurrence will continue to approve and authorize payments automatically.