Skip to main content
Below is a set of commands for self-hosted users, mostly for managing invoicing tasks, whether for immediate processing or scheduling. These commands run in a Rails console (rails c) inside a Docker container named api, managed by Docker Compose.

Bill a subscription for a future date

Use this to queue the billing of a subscription for a later issuance date. The job generates a real invoice, it is not a preview. Specify the correct subscription external_id, the targeted invoice issuance date, and an invoicing_reason.
invoicing_reason is required. It accepts subscription_starting, subscription_periodic, subscription_terminating, in_advance_charge, in_advance_charge_periodic and progressive_billing.

Issue an invoice immediately

Use this to issue an invoice right away. Specify the correct subscription external_id.

Remove cache for a subscription

Use this to remove the cache on a specific subscription.
To remove the cache for all subscriptions, you can alternatively use this command:

Audit logs of a subscription

Use this to view all changes applied to a subscription and identify which membership made those changes.