payments (certego_saas.apps.payments)

admin.py

---

class certego_saas.apps.payments.admin.CustomerAdmin(model, admin_site)

Bases: django.contrib.admin.options.ModelAdmin

Django’s ModelAdmin for Customer.

cache.py

---

certego_saas.apps.payments.cache.cache_memoize(*args, **kwargs)

Custom cache_memoize.

certego_saas.apps.payments.cache.get_cache()

Attempts to get the certego_saas.payments cache otherwise fallback to default cache

consts.py

---

exceptions.py

---

exception certego_saas.apps.payments.exceptions.CustomerCantSubmitMultipleProfilesException(detail=None, code=None)

Bases: rest_framework.exceptions.PermissionDenied

exception certego_saas.apps.payments.exceptions.CustomerCantSubmitPrivateException(detail=None, code=None)

Bases: rest_framework.exceptions.PermissionDenied

exception certego_saas.apps.payments.exceptions.CustomerWithoutSubscription(appname: str, detail=None, code=None)

Bases: rest_framework.exceptions.APIException

Raised when a given user/customer has no active subscription on stripe.

models.py

---

class certego_saas.apps.payments.models.AppChoices(value)

Bases: django.db.models.enums.TextChoices

An enumeration.

class certego_saas.apps.payments.models.Customer(*args, **kwargs)

Bases: django.db.models.base.Model

A wrapper class over stripe-python SDK combined with django’s User model that provides utilities for retrieving customer and their subscription details.

exception CustomerWithoutSubscription(appname: str, detail=None, code=None)

Bases: rest_framework.exceptions.APIException

Raised when a given user/customer has no active subscription on stripe.

create_billing_portal_session(return_url) → stripe.api_resources.billing_portal.session.Session

uses :meth:stripe.billing_portal.Session.create.

• Stripe Billing Portal settings

create_checkout_session(price_id, success_url, cancel_url) → stripe.api_resources.checkout.session.Session

uses :meth:stripe.checkout.Session.create.

• Stripe Checkout Docs

get_stripe_customer() → stripe.api_resources.customer.Customer

Returns instance of stripe.Customer for user.

• (uses :meth:stripe.Customer.retrieve()

class certego_saas.apps.payments.models.Subscription(*args, **kwargs)

Bases: certego_saas.ext.models.AppSpecificModel

Each Customer can have maximum len(AppChoices) number of related Subscription objects; one subscription for each app name (i.e. DRAGONFLY, INTELOWL, etc.).

property can_submit_private

metadata.submission_type == "private"

property concurrent_profiles

metadata.max_submissions

get_subscription(expand=None) → stripe.api_resources.subscription.Subscription

Returns customer’s active subscription.

• (uses :meth:stripe.Subscription.retrieve()

property monthly_submissions_limit

metadata.max_submissions

property priority

metadata.priority

subscribed_product() → stripe.api_resources.product.Product

Product details for the active subscription.

permissions.py

---

class certego_saas.apps.payments.permissions.UserHasActiveSubscription

Bases: rest_framework.permissions.BasePermission

Allows access to customers who have an active stripe subscription.

• Should be used along with rest_framework.permissions.IsAuthenticated.

serializers.py

---

class certego_saas.apps.payments.serializers.InvoiceSerializer(*args, **kwargs)

Bases: rest_framework.serializers.Serializer

Useful fields from stripe.Invoice

class certego_saas.apps.payments.serializers.ProductPriceSerializer(*args, **kwargs)

Bases: rest_framework.serializers.Serializer

Represents a combination of stripe.Product and stripe.Price.

class certego_saas.apps.payments.serializers.SubscriptionSerializer(*args, **kwargs)

Bases: rest_framework.serializers.Serializer

Useful fields from stripe.Subscription + custom fields

throttling.py

---

class certego_saas.apps.payments.throttling.SubscriptionRateThrottle

Bases: rest_framework.throttling.BaseThrottle

Restrict access if User.stripe.monthly_submissions_limit has been exhausted.

allow_request(request, view)

Return True if the request should be allowed, False otherwise.

wait()

calculates distance in seconds from current time to 1st of next month.

utils.py

---

certego_saas.apps.payments.utils.get_default_product() → dict

returns default product based on whether stripe is running in livemode or testmode

certego_saas.apps.payments.utils.get_products() → List[Dict]

Returns list of stripe plans/products.

Alias for stripe.Price.list(expand=["data.product"]).

certego_saas.apps.payments.utils.get_products_prices_map() → Dict[str, Dict]

Returns dict mapping of stripe plans/products.

Alias for stripe.Price.list(expand=["data.product"]).