wepay.calls.subscription_plan Module

class wepay.calls.subscription_plan.SubscriptionPlan(api)[source]

The /subscription_plan API calls

__call__(subscription_plan_id, **kwargs)[source]

Call documentation: /subscription_plan, plus extra keyword parameters:

Parameters:
  • access_token (str) – will be used instead of instance’s access_token, with batch_mode=True will set authorization param to it’s value.
  • batch_mode (bool) – turn on/off the batch_mode, see wepay.api.WePay
  • batch_reference_id (str) – reference_id param for batch call, see wepay.api.WePay
  • api_version (str) – WePay API version, see wepay.api.WePay
find(**kwargs)

Call documentation: /subscription_plan/find, plus extra keyword parameters:

Parameters:
  • access_token (str) – will be used instead of instance’s access_token, with batch_mode=True will set authorization param to it’s value.
  • batch_mode (bool) – turn on/off the batch_mode, see wepay.api.WePay
  • batch_reference_id (str) – reference_id param for batch call, see wepay.api.WePay
  • api_version (str) – WePay API version, see wepay.api.WePay
create(account_id, name, short_description, amount, period, **kwargs)

Call documentation: /subscription_plan/create, plus extra keyword parameters:

Parameters:
  • access_token (str) – will be used instead of instance’s access_token, with batch_mode=True will set authorization param to it’s value.
  • batch_mode (bool) – turn on/off the batch_mode, see wepay.api.WePay
  • batch_reference_id (str) – reference_id param for batch call, see wepay.api.WePay
  • api_version (str) – WePay API version, see wepay.api.WePay
delete(subscription_plan_id, **kwargs)

Call documentation: /subscription_plan/delete, plus extra keyword parameters:

Parameters:
  • access_token (str) – will be used instead of instance’s access_token, with batch_mode=True will set authorization param to it’s value.
  • batch_mode (bool) – turn on/off the batch_mode, see wepay.api.WePay
  • batch_reference_id (str) – reference_id param for batch call, see wepay.api.WePay
  • api_version (str) – WePay API version, see wepay.api.WePay
get_button(account_id, button_type, **kwargs)

Call documentation: /subscription_plan/get_button, plus extra keyword parameters:

Parameters:
  • access_token (str) – will be used instead of instance’s access_token, with batch_mode=True will set authorization param to it’s value.
  • batch_mode (bool) – turn on/off the batch_mode, see wepay.api.WePay
  • batch_reference_id (str) – reference_id param for batch call, see wepay.api.WePay
  • api_version (str) – WePay API version, see wepay.api.WePay
modify(subscription_plan_id, **kwargs)

Call documentation: /subscription_plan/modify, plus extra keyword parameters:

Parameters:
  • access_token (str) – will be used instead of instance’s access_token, with batch_mode=True will set authorization param to it’s value.
  • batch_mode (bool) – turn on/off the batch_mode, see wepay.api.WePay
  • batch_reference_id (str) – reference_id param for batch call, see wepay.api.WePay
  • api_version (str) – WePay API version, see wepay.api.WePay