Skip to main content

Billing Terms

Billing terms define how and when the customer is charged for the subscription.

Billing Cycles​

CycleFrequencyDuration
monthlyMonthly1 month
quarterlyQuarterly3 months
semiannualSemi-annual6 months
annualAnnual12 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 period
  • current_period_end: End of the current billing period

Collection Methods​

MethodInvoice GenerationCharge
charge_automaticallyAutomaticAutomatic
manual_chargeAutomaticManual
manual_invoiceManualManual

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:

BehaviorDescription
create_prorationsCreates proportional credits and charges (default)
noneNo proportional adjustment
always_invoiceAlways generates an invoice for the difference

Trial Period​

  • Configurable from 0 to 90 days
  • During the trial, the subscription has trialing status
  • At the end of the trial, the subscription changes to active and the billing period begins

Subscription Permissions​

SettingDescription
allow_pauseWhether the customer can pause the subscription
allow_cancelWhether the customer can cancel the subscription

These settings can be defined per subscription and control the options available in the customer portal.