Unable to cancel stripe subscription at period end

Python 3.6.5

stripe 2.10.1

According to the docs https://stripe.com/docs/billing/subscriptions/canceling-pausing I am doing the following:

stripe_subscription = stripe.Subscription.retrieve(self.stripe_id)
stripe_subscription.update(cancel_at_period_end=True)

However it throws an error: TypeError: update() got an unexpected keyword argument 'cancel_at_period_end'

I have managed to get it working by changing it to:

stripe_subscription = stripe.Subscription.retrieve(self.stripe_id)
stripe_subscription.update({'cancel_at_period_end': True})
stripe_subscription.save()

However either the code or the documentation need to be updated. However for I think it will it will be better if we can do the following:

subscription.cancel()  # cancels subscription immediately
subscription.cancel(at_period_end=True)  # cancels subscription at period end

Both methods should commit the change so there is no need to call .save() explicitly.

I am willing to provide a fix in a PR if this sounds good to you.

[ob-stripe]

The documentation is now fixed!

[IlianIliev]

Hi @ob-stripe , and thank for the quick reply.

Yes, it is mostly an issue with the documentation but I had no idea where report it so I posted here.

Regarding the library itself - I still find the cancellation process a bit confusing. It uses delete to cancel a subscription, but the subscription is not actually deleted and just marked as cancelled. I checked the REST API and apparently this is the situation there (it uses the DELETE method) for cancelling it, so I can kind of understand why the library uses that method. However I still think that having a cancel method will be more convenient and clear for developers so if you ever decide to go in that direction just ping me, I’ll be happy to help )