gagan-subscription-cancel | Stripe Developers | Page 1

pliant moatBOT Aug 7, 2023, 4:52 PM

#

ruby copper Aug 7, 2023, 4:52 PM

#

Hi 👋

What is your specific question about the Subscription webhooks?

meager slate Aug 7, 2023, 4:53 PM

#

i have a few usecases. and im having trouble trying to figure out which event types to use.

#

theyre both revolving around canceling a subscription.
`//if manually canceled, dont update plan to free or set planTier to 0, until next invoice

//if canceled due to failed payment, set planTier to 0`

ruby copper Aug 7, 2023, 4:55 PM

#

Okay those are just comment strings. Why do they need to be code formatted?

meager slate Aug 7, 2023, 4:55 PM

#

`case 'customer.subscription.updated':
const paymentIntent = event.data.object
clientReferenceId = paymentIntent.client_reference_id
const subscriptionId = paymentIntent.subscription

            //if manually canceled, dont update plan to free and set planTier to 0, until next invoice
            const subscription = await stripe.subscriptions.update(subscriptionId, {
                cancel_at_period_end: true
            })

            //if canceled due to failed payment, set planTier to 0
            if (!paymentIntent.paid) await createPlanHelper(request, db, clientReferenceId, 0)
            break`

#

this is the code

ruby copper Aug 7, 2023, 4:55 PM

#

Please descibe in words what you are trying to do

meager slate Aug 7, 2023, 4:58 PM

#

if the subscription is terminated due to failed payment, set planTier to 0.

if the user manually canceled, we want to cancel subscription but provide it for the remainder of the billing month/year.

im assuming the second scenario ties into the first one. because itll automatically cancel it when its end of billing month.

#

is the
case 'customer.subscription.updated':

the correct event to use?

ruby copper Aug 7, 2023, 4:59 PM

#

That event will capture both scenarios yes

#

And the updated event will include a previous_attributes hash that will show you what changed

#

You can use this to determine which scenario applies

#

But I would recommend also listening to invoice.payment_failed https://stripe.com/docs/api/events/types#event_types-invoice.payment_failed

meager slate Aug 7, 2023, 5:06 PM

#

so for this code:

` //if manually canceled, dont update plan to free and set planTier to 0, until next invoice
const subscription = await stripe.subscriptions.update(subscriptionId, {
cancel_at_period_end: true
})

            //if canceled due to failed payment, set planTier to 0
            if (!paymentIntent.paid && ) await createPlanHelper(request, db, clientReferenceId, 0)`

the subscription will let me know if its end of billing cycle and it wasn't paid? or will the updated.previous_attributes be of better use?

#

im trying to understand the flow. and remove any unnecessary code

ruby copper Aug 7, 2023, 5:07 PM

#

This should be pretty simple to test

#

You can use Test Clocks to validate both behaviors
https://stripe.com/docs/billing/testing/test-clocks

meager slate Aug 7, 2023, 5:08 PM

#

is invoice.payment_failed called at end of billing period?

ruby copper Aug 7, 2023, 5:09 PM

#

invoice.payment_failed will fire when ever an Invoice payment attempt fails

meager slate Aug 7, 2023, 5:09 PM

#

so i dont want to update our internal DB until end of billing period.

ruby copper Aug 7, 2023, 5:09 PM

#

That's up to you

meager slate Aug 7, 2023, 5:10 PM

#

right but if i put the code in invoice.payment_failed, it will do it immediately.

#

so invoice.payment_failed is not the right event type then.

#

in a preivous chat, they told me to use stripe.subscriptions.update with cancel_at_period_end

ruby copper Aug 7, 2023, 5:12 PM

#

Okay sure, that'll work. Have you tested it?

meager slate Aug 7, 2023, 5:13 PM

#

no because i need to know what to use the subscription for. what variable can i use to determine if its ok to call the internal DB subscription update:

`const subscription = await stripe.subscriptions.update(subscriptionId, {
cancel_at_period_end: true
})

            if (!paymentIntent.paid && ) await createPlanHelper(request, db, clientReferenceId, 0)

`

!paymentIntent.paid && <what goes here>

ruby copper Aug 7, 2023, 5:14 PM

#

That is up to you. You need to test your code and determine what makes sense for you

meager slate Aug 7, 2023, 5:15 PM

#

you're not understanding, im asking what the variable is that i can use from subscription update call that will tell me that its end of billing period and subscription is canceled?

ruby copper Aug 7, 2023, 5:16 PM

#

You said it yourself. cancel_at_period_end == true

#

Have you looked at the cancellation_details hash?

meager slate Aug 7, 2023, 5:17 PM

#

thats the a parameter im using

ruby copper Aug 7, 2023, 5:17 PM

#

https://stripe.com/docs/api/subscriptions/object#subscription_object-cancellation_details

meager slate Aug 7, 2023, 5:17 PM

#

ruby copper Have you looked at the `cancellation_details` hash?

no. one second

ruby copper Aug 7, 2023, 5:18 PM

#

meager slate thats the a parameter im using

But it is also returned on the Subscriptioin object

meager slate Aug 7, 2023, 5:20 PM

#

this should handle all cases then:

if (!paymentIntent.paid && subscription.cancellation_details.payment_failed) { await createPlanHelper(request, db, clientReferenceId, 0) }

#

subscription.cancellation_details.payment_failed

#

sorry:

subscription.cancellation_details.reason

ruby copper Aug 7, 2023, 5:21 PM

#

Yes

meager slate Aug 7, 2023, 5:21 PM

#

how do i get the enum?

#

is that a string?

ruby copper Aug 7, 2023, 5:22 PM

#

I would still recommend writing tests using the Test Clocks to simulate the behavior

meager slate Aug 7, 2023, 5:23 PM

#

i underrstand but testing without fully understanding what the events will do is innefficient.

#

so this may causes issues here:

        case 'customer.subscription.updated':

is called for all change cases.

we want to handle just the cancellation (user cancels, payment fails due to end of billing cycle, and switch to free plan cases).

in this code, it will call the update subscriptions function every time to cancel at period end.

ruby copper Aug 7, 2023, 5:27 PM

#

Then you should inspect the Subscription object and only trigger that code if it's appropriate

meager slate Aug 7, 2023, 5:29 PM

#

const subscription = await stripe.subscriptions.update(subscriptionId, {
cancel_at_period_end: true
})

is inside the customer.subscription.update event.

#

so it will trigger cancellation every time.

#

what variable is in the custom.subscription.updated event that i can use to check if a switch of plan or cancellation is triggered?

pliant moatBOT Aug 7, 2023, 5:33 PM

#

silent wind Aug 7, 2023, 5:37 PM

#

gagan-subscription-cancel

#

@meager slate I'd recommend pausing the theory and just trying the API in Test mode yourself. It will be a lot easier for you to make sense of what happens exactly, look at the raw JSON in each Event and connect the dots.

#

It's important as I've seen you ask about this for a few days on multiple threads already and it would be a lot easier to just try and check how cancel_at_period_end, cancel_at, canceled_at and other properties are being set

meager slate Aug 7, 2023, 5:39 PM

#

ok

#

ill give it a shot

#

but i can already see an issue and dont know how to solve it

silent wind Aug 7, 2023, 5:40 PM

#

meager slate Aug 7, 2023, 5:41 PM

#

customer.subscription.updated event is called on change (subscribed or unsubscribed).

await stripe.subscriptions.update is called with cancel_at_period_end in both cases.

silent wind Aug 7, 2023, 5:47 PM

#

So what's the problem exactly? Sorry you're not really explaining what's blocking you. Really if you test this carefully in Test mode you'll see exactly what you need

meager slate Aug 7, 2023, 5:53 PM

#

meager slate what variable is in the custom.subscription.updated event that i can use to chec...

this.

#

const subscription = await stripe.subscriptions.update(subscriptionId, { cancel_at_period_end: true })

this code needs to be wrapped in an if statement to check if status is past_due, canceled, or unpaid.

#

where do i get the status from inside event customer.subscription.updated

silent wind Aug 7, 2023, 5:55 PM

#

Can you give me a concrete example of an Event you're looking at with the exact evt_123?

meager slate Aug 7, 2023, 5:55 PM

#

what is evt_123?

silent wind Aug 7, 2023, 5:58 PM

#

evt_123 is an example id of an Event object. I'm asking what example you're looking at so that I can show you where to look

#

@meager slate do you have that example Event id so that I can help you?

meager slate Aug 7, 2023, 6:06 PM

#

i dont because im still writing the code. once i start testing it, i will send it

silent wind Aug 7, 2023, 6:11 PM

#

Okay so my advice is the same I gave earlier. For now pause writing the code for a bit and focus on testing those flows end to end and looking at what happened.

#gagan-subscription-cancel