Billing Terms
Billing terms define how and when the customer is charged for the subscription.
Billing Cycles​
| Cycle | Frequency | Duration |
|---|---|---|
monthly | Monthly | 1 month |
quarterly | Quarterly | 3 months |
semiannual | Semi-annual | 6 months |
annual | Annual | 12 months |
Billing Anchor​
Billing periods are calculated entirely from current_period_start and current_period_end, which advance on every renewal. The cycle billing day lives in cycle_billing_date, set when the subscription is activated.
Current Period​
current_period_start: Start of the current billing periodcurrent_period_end: End of the current billing period
Collection Methods​
| Method | Invoice Generation | Charge |
|---|---|---|
charge_automatically | Automatic | Automatic |
manual_charge | Automatic | Manual |
manual_invoice | Manual | Manual |
Automatic Charge (charge_automatically)​
- The invoice is generated automatically by the worker
- Upon finalization, the system attempts to charge automatically using the customer's default payment method
- For card: immediate charge
- For boleto (bank slip) / PIX (instant payment): generates the charge and awaits confirmation via webhook
- On failure: schedules retry attempts (dunning)
Manual Charge with Automatic Invoice (manual_charge)​
- The invoice is created automatically by the worker
- The customer receives the invoice by email
- Payment is made manually (boleto, PIX) or the operator triggers the charge
Manual Invoice and Manual Charge (manual_invoice)​
- No invoices are generated automatically
- The operator creates invoices manually as needed
- Useful for one-time charges or irregular billing
Proration Behavior​
Configures how mid-cycle plan changes are handled:
| Behavior | Description |
|---|---|
create_prorations | Creates proportional credits and charges (default) |
none | No proportional adjustment |
always_invoice | Always generates an invoice for the difference |
Trial Period​
- Configurable from 0 to 90 days
- During the trial, the subscription has
trialingstatus - At the end of the trial, the subscription changes to
activeand the billing period begins
Subscription Permissions​
| Setting | Description |
|---|---|
allow_pause | Whether the customer can pause the subscription |
allow_cancel | Whether the customer can cancel the subscription |
These settings can be defined per subscription and control the options available in the customer portal.