The Subscriptions endpoints let you create and manage recurring payments for the same customer. New payments are generated over the course of the recurrence according to the configured billing cycle, and each payment has its own ID, status, and financial cycle.
Available operations
- Creation: create recurring subscriptions with bank slip (boleto), Pix, or credit card.
- Retrieval and management: list or retrieve subscriptions, change their settings, or end the recurrence.
- Card and generated payments: update the card used for upcoming payments, query the payments already generated, and get the subscription booklet.
- Invoices: configure and manage the automatic issuance of NFS-e for the subscription's payments and query the generated invoices.
Tracking changesUse Webhooks to track the lifecycle of the subscription and the generated payments, instead of repeatedly querying the retrieve and list endpoints.
To understand recurrence and choose the implementation flow, see Introduction - subscriptions.
