dev

Pause Stripe Subscription

Pause a user's monthly Stripe subscription (dev-only endpoint).

Calls stripe.Subscription.modify with pause_collection to suspend invoice generation without cancelling the subscription.

Marks paid_users.stripe_payment_status as "paused" so the user immediately loses paid access and shows as "Free" in the app. This is safe because handle_subscription_updated also maps a subscription with pause_collection set to "paused", so the webhook keeps the local marker in sync rather than overwriting it back to "active".

To resume, clear pause_collection via the Stripe API — Stripe then fires customer.subscription.updated with status "active", which restores the "active" marker and paid access.

post/api/v1/dev/pause-stripe-subscription

Request

  • Base URL: https://api.trylapis.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.trylapis.com/api/v1/dev/pause-stripe-subscription
  • Auth: none declared

Headers

x-lapis-dev-tokenstring

Request body

emailstring required

User email address

behaviorstring

Stripe pause behavior: 'void', 'mark_uncollectible', or 'keep_as_draft'. Defaults to 'mark_uncollectible' (no invoices issued while paused).

Response

Successful Response

statusstring required
messagestring required
user_idinteger required
user_emailstring required
stripe_subscription_idstring required
stripe_subscription_statusstring required
pause_behaviorstring required
pause_collection_activeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.