docs: add customer_billing app reference and update lifecycle doc - #228
Open
iloveagent57 wants to merge 1 commit into
Open
docs: add customer_billing app reference and update lifecycle doc#228iloveagent57 wants to merge 1 commit into
iloveagent57 wants to merge 1 commit into
Conversation
Add customer-billing-app-reference.rst covering the app module structure, models, Stripe event handlers, Celery tasks, management commands, and external service dependencies. Update subscription-and-renewal-lifecycle.rst with gaps identified during the architecture review: - Expand CheckoutIntent state field to show full state machine including ERRORED_FULFILLMENT_STALLED and recovery paths - Document checkout_intent_uuid vs checkout_intent_id lookup fallback on StripeEventData, and add handled_at field description - Explain the invoice.created / invoice.paid two-event split and out-of-order delivery handling in the trial-to-paid section - Add Management Commands section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #228 +/- ##
=======================================
Coverage 87.06% 87.06%
=======================================
Files 155 155
Lines 13014 13014
Branches 1249 1249
=======================================
Hits 11331 11331
Misses 1375 1375
Partials 308 308 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR expands the Customer Billing documentation set by adding a module-level reference for the customer_billing Django app and tightening the subscription/renewal lifecycle narrative to reflect additional states, webhook processing details, and operational tooling.
Changes:
- Added
customer-billing-app-reference.rstdescribing core models, key modules, Celery tasks, management commands, and external dependencies. - Expanded
subscription-and-renewal-lifecycle.rstwith a fullerCheckoutIntent.statestate machine,StripeEventData.handled_at+ checkout intent lookup behavior, and detailed handling forinvoice.created/invoice.paidordering. - Documented operational management commands in the lifecycle doc.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/customer-billing/subscription-and-renewal-lifecycle.rst | Expands lifecycle/state-machine and webhook-processing docs; adds management commands section. |
| docs/customer-billing/customer-billing-app-reference.rst | New module-level reference for the customer_billing app structure, behavior, and dependencies. |
| +------------------------------------+------------------------------------------------------------------+ | ||
| | ``backfill_subscription_renewals`` | Data migration helper for ``SelfServiceSubscriptionRenewal`` | | ||
| +------------------------------------+------------------------------------------------------------------+ | ||
| | ``populate_stripe_event_summaries``| Backfill ``StripeEventSummary`` records from existing event data | |
| Management Commands | ||
| ------------------- | ||
|
|
||
| Operational commands for routine maintenance and data recovery: |
| +------------------------------------+------------------------------------------------------------------+ | ||
| | ``backfill_subscription_renewals`` | Data migration helper for ``SelfServiceSubscriptionRenewal`` | | ||
| +------------------------------------+------------------------------------------------------------------+ | ||
| | ``populate_stripe_event_summaries``| Backfill ``StripeEventSummary`` records from existing event data | |
Comment on lines
+51
to
+52
| Raw Stripe event payload storage. PII-flagged (``email_address``) — scrubbed after 90 days via | ||
| management command. Linked to ``CheckoutIntent`` via Stripe customer ID cross-referenced with |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add customer-billing-app-reference.rst covering the app module structure, models, Stripe event handlers, Celery tasks, management commands, and external service dependencies.
Update subscription-and-renewal-lifecycle.rst with gaps identified during the architecture review:
Motivation: qualitative exploration of whether https://github.com/abhigyanpatwari/GitNexus can help LLMs more thoroughly and correctly read, trace, and explain our code.
Merge checklist:
./manage.py makemigrationshas been runPost merge: