Subscription Module

enum q2_marketplace.subscription.EntitlementType(value)[source]

Valid values are as follows:

user = <EntitlementType.user: 'user'>
customer = <EntitlementType.customer: 'customer'>
exception q2_marketplace.subscription.CancelationException[source]
async q2_marketplace.subscription.is_valid(logger, extension_name, user_id, hq_credentials=None)[source]
Return type:

bool

async q2_marketplace.subscription.cancel(logger, extension_name, customer_key, customer_or_user_id, hq_credentials=None)[source]

This method will cancel a q2 marketplace subscription by canceling it with app direct.

Parameters:

  • extension_name (str) – The name of an extension

  • customer_key (str) – the q2 marketplace customer key from which to remove the extension

  • customer_or_user_id (int) – the id (integer) corresponding to the q2 customer or user that owns the subscription, depending on the extension product entitlement belonging to customer or users at the FI

Return type:

None