Upgrading to Spark (Stripe) 5.0 From 4.x
Spark (Stripe) 5.0 primarily provides an upgrade from Cashier 14.x to Cashier 15.x. As such, in addition to the upgrade guide below, please consult the Cashier 15 upgrade guide.Stripe API Version
The default Stripe API version for Cashier 15.x is2023-10-16
.
If you use the Stripe SDK directly, make sure to properly test your integration after updating.
Upgrading Your Stripe Webhook
It’s very important that you upgrade your webhook immediately after updating and deploying Spark in order to minimize conflicts where the API version of your webhook does not match the version used by Cashier.
cashier:webhook
command from your production environment to create a new webhook that matches Cashier’s Stripe API version. Of course, you should ensure the webhook’s URL corresponds to the URL where your application expects to receive webhook requests. By default, your application will receive Spark Stripe webhooks at /spark/webhook
:
- If you have webhook signature verification enabled, disable it on production by temporarily removing the
STRIPE_WEBHOOK_SECRET
environment variable. - Add any extra Stripe events your application requires to the new webhook in your Stripe dashboard.
- Disable the old webhook in your Stripe dashboard.
- Enable the new webhook in your Stripe dashboard.
- Re-enable the new webhook secret verification by re-adding the
STRIPE_WEBHOOK_SECRET
environment variable in production with the secret from the new webhook. - Remove the old webhook in your Stripe dashboard.
Publishing Migrations
Spark Stripe 5.0 no longer automatically loads migrations from its own migrations directory. Instead, you should run the following command to publish Spark’s migrations to your application:Receipts Table Deprecation
While thereceipts
table contains historical data that may be valuable for reference, it is no longer used and can be safely removed.
Receipts Renamed to Invoices
Code and text throughout Spark Stripe has been updated to refer to “receipts” as “invoices”. This is to bring Spark Stripe closer to Stripe’s own terminology for this concept. To accomodate this, you should make the following changes to your application: First, rename the corresponding feature flag in yourspark.php
config:
receipt_data
key in your application’s config/spark.php
configuration file to invoice_data
:
vendor:publish
Artisan command, you should rename the receipt.blade.php
template to invoice.blade.php
in your application’s resources/views/vendor/spark/mail
directory.
Lastly, create a migration to rename the user
table’s receipt_emails
column to invoice_emails
: