lec1892_api | Stripe Developers | Page 1

ivory oracleBOT Oct 9, 2024, 7:30 PM

#

👋 Welcome to your new thread!

⏲️ We'll be here soon! Typically we respond in a few minutes, but sometimes we might take a bit longer if the server is busy or if you have a particularly tricky question.

⏱️ We close idle threads, which makes them read-only. Once a thread is closed it won't be reopened, but you can always start a new thread if you have another question.

🔗 This thread will always be available, even after it's closed. You can find it again using Discord's search, or you can save this link: https://discord.com/channels/841573134531821608/1293656804047192136

📝 Have more to share? Add more details, code, screenshots, videos, etc. below.

Below are links to other discussions we've had with you in the past week in case you want to review that information. If your question is related to one of these previous discussions, please provide a comprehensive summary of the current state and what you need help with now. We help many users simultaneously, so a summary allows us to resolve your issue as soon as possible.

lec1892_api, 3 hours ago, 12 messages

#

brave kraken Oct 9, 2024, 7:31 PM

#

Hello

#

Proration does not take into account the state of previous invoices.

#

This is expected.

#

If you don't want proration to occur, then you need to disable it.

warm mist Oct 9, 2024, 7:33 PM

#

So if a subscription is unpaid, and then it is canceled, the customer will receive credits even though he has not performed the payment just because the proration is enabled?

brave kraken Oct 9, 2024, 7:35 PM

#

Yes that is the expected behavior. The API was designed with the concept of you controlling this via designating proration and you collecting payment for any previously unpaid Invoices while you granted access to your Subscription if you so desire.

When a cancellation or an update of a Subscription occurs, the state of any previous Invoices is never taken into account for proration.

warm mist Oct 9, 2024, 7:38 PM

#

In case I need to keep prorations enabled, but if the customer has an unpaid invoice he should not receive credits, what should I do? Flag the invoice as paid even though it was not?

brave kraken Oct 9, 2024, 7:39 PM

#

No nothing you do to the Invoice will affect proration

#

So in that case you would delete the Invoice item that was generated from the proration using https://docs.stripe.com/api/invoiceitems/delete

warm mist Oct 9, 2024, 7:42 PM

#

So, after the subscription is canceled and the proration invoice is generated to grant credits to the customer (-99,99), then I should delete the invoice item, so the customer won't receive credits. Is that what you mean?

brave kraken Oct 9, 2024, 7:44 PM

#

How are you canceling the Subscription here?

#

You are using the Cancel endpoint: https://docs.stripe.com/api/subscriptions/cancel ?

warm mist Oct 9, 2024, 7:45 PM

#

the customer cancels from the customer portal

brave kraken Oct 9, 2024, 7:45 PM

#

Ah

#

Okay in that case you need to remove the Credit Balance from the Customer

#

So what will happen is the Invoice Item will immediately be added to a new Invoice and finalized.

#

That will then add a credit to the Customer to be applied to the next Invoice

#

You can see the Customer balance via: https://docs.stripe.com/api/customers/object#customer_object-balance

#

And you can update that to set it to 0 to remove that credit balance: https://docs.stripe.com/api/customers/update#update_customer-balance

warm mist Oct 9, 2024, 7:49 PM

#

ok, so that's an option = remove the customer credit balance
and the most simple option is to disable proration, right?

brave kraken Oct 9, 2024, 7:49 PM

#

You can't actually disable proration for Customer Portal cancellations.

#

That isn't a feature that has been added yet for Customer Portal.

#

So this is your only option right now.

#

I believe there is an outstanding feature request that will hopefully be worked on soon for controlling proration with Customer Portal Cancellations

warm mist Oct 9, 2024, 7:55 PM

#

are you sure that when the customer cancels the subscription from the customer portal the proration behavior will always be enabled?

#

This is the customer portal settings screen

brave kraken Oct 9, 2024, 7:56 PM

#

Doh

#

Thanks for checking

#

We haven't enabled this as an API parameter yet

#

But you can set it in the Dashboard for your default config

warm mist Oct 9, 2024, 7:56 PM

#

what about customer portal configuration api?

#

when creating a customer portal session I can specify the configuration id

brave kraken Oct 9, 2024, 7:56 PM

#

Yeah not available via the API yet: https://docs.stripe.com/api/customer_portal/configurations/create#create_portal_configuration-features-subscription_cancel-enabled

#

That's what I was referencing above

#

Wait

#

Ugh sorry

#

It was added recently: https://docs.stripe.com/api/customer_portal/configurations/create#create_portal_configuration-features-subscription_cancel-proration_behavior

#

lol sorry

#

So yes, you can control it via the API as well

warm mist Oct 9, 2024, 7:57 PM

#

let me check my configuration

#

I remembered about it just now

#

one sec please

brave kraken Oct 9, 2024, 7:58 PM

#

Sure

#

If you aren't specifying anything then it defaults to create_prorations

#

So you want to set it to none

warm mist Oct 9, 2024, 7:58 PM

#

ok let me check

#

my customer portal configuration is not correct.
"proration_behavior": "create_prorations"

#

I will fix that

#

thank you for helping me to troubleshoot that

#lec1892_api