Skip to content

CON-MBR-MEM-005Billing Run

Markdown

CON-MBR-MEM-005

Billing Run

Markdown
  • DocumentDraft
  • Product intentConfirmed
  • ImplementationPartially observed

Planning

Feature
FEAT-MBR-MEM-05
Owned by
MOD-MBR-MEM
Acted on by
CAP-MBR-MEM-013
Visible to
ACT-MBR-006, ACT-MBR-008
Not to be confused with
Other billing domains own invoice runs for their products., Commerce owns the orders requested by membership billing.

Design

Specified by
DOM-MBR-MEM-005

KindKey conceptProduct areaMembershipModuleMemberships, Applications and Membership BillingRevision1

Read atservices-membership 5994c270react-console baf6dae3

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Definition
A billing run selects ending membership periods for a program, records planned renewal and closure actions, and tracks their execution outcomes.
Synonyms
renewal rundues billing run

Relationships

ToStatementProvenance
CON-MBR-MEM-002The run selects ending terms and retains the term and planned version on each action.observed
CON-MBR-MEM-001Suspension and origin affect candidate selection, while do-not-renew and do-not-drop govern which actions are planned for candidates.observed

Lifecycle

StateMeaningHow it changes
draftThe run exists but has not yet selected its candidates.Planning records candidates and actions, or cancellation stops the run.
plannedThe recorded plan is available for review.The administrator can replan, execute or cancel it.
executingThe run has an execution job responsible for its planned actions.Completion marks it executed; the matching job’s failure consequence can return it to planned.
executedExecution has settled the available actions.Another execution request can create a job without repeating already settled actions.
cancelledThe run stops before execution while retaining its planned work.No further run operation resumes the cancelled plan.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.