[FIXED] How to add foreign-key column to dj-stripe admin?

Issue

I would like to add plan names to dj-stripe django admin so I can see a readable name for what each subscription is associated with. Adding "cancel_at" worked, but I can't use the name of a Product from a Plan.

In my_app\admin.py I do this:

from djstripe.models import Subscription
from djstripe.admin import StripeModelAdmin, SubscriptionItemInline

...

class SubscriptionAdmin(StripeModelAdmin):
    list_display = ("plan__product__name", "customer", "status", "cancel_at")
    list_filter = ("status", "cancel_at_period_end")
    list_select_related = ("customer", "customer__subscriber")
    inlines = (SubscriptionItemInline,)
    def _cancel(self, request, queryset):
        """Cancel a subscription."""
        for subscription in queryset:
            subscription.cancel()

    _cancel.short_description = "Cancel selected subscriptions"  # type: ignore # noqa
    actions = (_cancel,)


admin.site.unregister(Subscription)
admin.site.register(Subscription, SubscriptionAdmin)

...

Which produces this error:

Subscription has no field named 'plan__product__name'

How do I add extra columns in dj-stripe that require foreign key lookups?

Solution

One solution is to make a callable then reference it in the modeladmin class.

Per the docs:

ModelAdmin.list_display

Set list_display to control which fields are displayed on the change list page of the admin.

There are four types of values that can be used in list_display. All but the simplest may use the display() decorator is used to customize how the field is presented:

A callable that accepts one argument, the model instance. For example:

@admin.display(description='Name')
    def upper_case_name(obj):
        return ("%s %s" % (obj.first_name, obj.last_name)).upper()

class PersonAdmin(admin.ModelAdmin):
    list_display = (upper_case_name,)

Which means in my case I can do this to add a combined tier + interval column:

@admin.display(description='Subscription Tier and Interval')
def subscription_tier_interval(obj):
    return ("%s - %s" % (obj.plan.product.name, obj.plan.interval))


class SubscriptionAdmin(StripeModelAdmin):
    list_display = ("customer", "status", subscription_tier_interval, "cancel_at")
    list_filter = ("status", "cancel_at_period_end")
    list_select_related = ("customer", "customer__subscriber")
    inlines = (SubscriptionItemInline,)
    def _cancel(self, request, queryset):
        """Cancel a subscription."""
        for subscription in queryset:
            subscription.cancel()

    _cancel.short_description = "Cancel selected subscriptions"  # type: ignore # noqa
    actions = (_cancel,)

admin.site.unregister(Subscription)
admin.site.register(Subscription, SubscriptionAdmin)

Answered By - womblerone