v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

manage

Retrieve data relevant to connecting to Stripe.

get/manage/api/stripe_subscription

Query parameters

organization_idstring required

Workspace to set up Stripe for. Caller must be OWNER, ADMIN, or MEMBER of the org.

isBusinessboolean

Whether the subscription is intended to be used for business or personal use.

Response

API subscription content related to connecting to Stripe

stripe_subscription_urlstring

The URL for the user to checkout the Stripe subscription plan. Soft-deprecated — this is the legacy $0-subscription flow; new clients use stripe_payment_setup_url instead. Removed once no callers reference it.

stripe_payment_setup_urlstring

The URL for the user to capture a payment method via hosted Stripe Checkout (mode='setup'). No charge happens during this flow; the captured payment method is attached to the org's Stripe Customer via the checkout.session.completed webhook.

stripe_billing_urlstring

DEPRECATED. The URL for the user to manage the existing Stripe subscription plan. Get this from ManageApiSubscriptionResponse instead.

Example response

{
  "stripe_subscription_url": "stripe_subscription_url",
  "stripe_billing_url": "stripe_billing_url",
  "stripe_payment_setup_url": "stripe_payment_setup_url"
}