Schedule collections · Reviewed 24 October 2026

Recurring billing, installments and subscriptions

Choose recurring invoices, a fixed installment plan or automatic charges, and inspect the schedule before activation.

Choose the billing model

Model	What it does	Good fit
Flexible partial invoice	One invoice with a balance; customer chooses payment amounts.	Layby or a deposit plus balance without a fixed schedule.
Recurring plan	Repeats the configured amount and interval until ended.	Rent, clubs or gym billing.
Installment plan	Runs a fixed number of billing cycles.	School fees or a scheduled purchase balance.
Invoice billing mode	Generates invoices for the customer to pay.	Scheduled reminders and collection requests.
Charge billing mode	Attempts collection using the configured saved payment method.	An authorized recurring debit with a supported method.

Recurring and installment are plan kinds; invoice and charge are billing modes. Generating an invoice does not mean it was paid.

Set up through the assistant

Open Assistant and choose Monthly rent, School fees or Memberships, or describe the required schedule.
Provide the customer, amount or total, frequency, first billing date and installment count where relevant. State whether you want invoices or automatic charges.
Review the resulting plan and enrollment details, including the actual total across rounded installments, before approving.
Inspect generated invoices or charge results and follow-up failures. Cancel or end the schedule through its supported workflow when billing should stop.

There is no separate Plans or Subscriptions item in the current dashboard sidebar. The assistant and merchant APIs provide these capabilities.

Use plans and subscriptions via API

Capability	Operations / scopes
Plan templates	`POST /v1/plans`, `GET /v1/plans`, `GET /v1/plans/{id}`, `POST /v1/plans/{id}/deactivate`; `plans.read` / `plans.write`.
Subscriptions	`POST /v1/subscriptions`, `GET /v1/subscriptions`, `GET /v1/subscriptions/{id}`, `POST /v1/subscriptions/{id}/cancel`; `subscriptions.read` / `subscriptions.write`.

Specify kind (RECURRING or INSTALLMENT), billing_mode (INVOICE or CHARGE), name, currency, interval and amount. For installments, include the installment count and use either per-cycle amount or total amount as required by the contract. Check returned total_collected: rounding a total into equal installments can change the final sum.

Subscription creation requires plan_id, yeboid_sub and payment_method_id. Use a stable Idempotency-Key. Inspect status and the first charge result; a newly created subscription can be incomplete after a payment failure. Live enablement, a supported saved method and customer authorization are prerequisites. Do not assume the sandbox charge simulator covers recurring billing.

Explore the other features

Browse all guides