@tryghost/mg-stripe v0.2.1
Migrate Stripe
Migrate Stripe products, prices, coupons, subscriptions and invoices from an old to a new Stripe account.
Install
Install the migrate CLI @tryghost/migrate
as a global package:
npm install --global @tryghost/migrate
To use this package in your own project:
npm install @tryghost/mg-stripe --save
or
yarn add @tryghost/mg-stripe
Usage
Pre-requisites
Before proceeding, be sure to have: 1. Disabled new subscriptions on the old site 2. Copied all Stripe customers, using the Stripe dashboard (docs)
Copy
The copy
command makes a copy of products, prices, coupons, invoices and subscriptions from the old to the new Stripe account. It will also pause existing subscriptions in the old Stripe account.
migrate stripe copy
We recommend running a dry run first, with the option --dry-run
. The dry run will not create any data in the new Stripe account, nor update any data in the old Stripe account.
migrate stripe copy --dry-run
Some other useful options are:
--from
: the Stripe API secret key of the old account (optional)--to
: the Stripe API secret key of the new account (optional)--delay
: Period (in hours, starting now) during which payment collection is paused. This period should be large enough to cover the entire migration. Estimated time to migrate 10,000 members is 1 hour, we recommend adding an extra hour of buffer time to be safe (optional)--subscription
: Only migrate a specific subscription id (optional). The value should be the subscription ID, i.e.sub_1234abcd5678efgh1234abcd
See full list of options here.
Confirm
The command
command confirms a previously created copy. It will finalise subscriptions and invoices in the new Stripe account.
migrate stripe confirm
Revert
The revert
command reverts the copy. It will delete any data created in the new Stripe account and resume subscriptions in the old Stripe account.
migrate stripe revert
Develop
This is a mono repository, managed with lerna. Follow the instructions for the top-level repo.
Install
cd
to the top of the monorepo- Run
yarn
to install dependencies.
Run
cd
to the top of the monorepo- Run
yarn dev:watch
(compiles TypeScript files) - Run
yarn dev stripe <command>
to run the copy, confirm or revert command
Test
yarn lint
to run lintingyarn test
to run unit tests
To run E2E tests, you need a test Stripe API-key. Create a .env
file and store it in this folder (packages/mg-stripe):
STRIPE_API_KEY=sk_test_xxx
After that you can run the E2E tests via yarn test:e2e
.
To easily filter and write new E2E tests you can run it like yarn test:e2e same-account
to only run E2E tests that match a file name.
Copyright & License
Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.