subscriptions

Initiate a subscription upgrade

Initiates the upgrade process for the organization's subscription with Stripe-based payments.

This creates a new Stripe SetupIntent and a PENDING StripeSubscription to initiate the upgrade flow. The client will use the returned intent secret to complete the payment method setup on the frontend. The PENDING StripeSubscription does not become the organization's active subscription as a result of this call (see the upgrade_confirmation endpoint below).

The Stripe subscription webhook handler will then finalize the upgrade once the payment method is confirmed and successfully attached by Stripe (see src.routers.webhook.stripe).

post/subscriptions/upgrade

Request

  • Base URL: https://api.cloud.wherobots.com
  • URL: https://api.cloud.wherobots.com/subscriptions/upgrade
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Successful Response

idstring required
createTimestring date-time required
updateTimestring date-time required
stoppedTimestring date-time nullable required
state'PENDING' | 'ACTIVE' | 'ACTIVE_PROBATION' | 'FAILED' | 'STOPPED' required
stripeCustomerIdstring required
intentSecretstring nullable

Changes

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