Organization Billing

Open Billing Portal

Changed on

Open the Stripe customer billing portal.

This is the correct destination for a "Manage subscription" action: the portal lets an existing customer update their card, view/download invoices, and change or cancel their plan. It is NOT the same as POST /subscribe — re-running /subscribe for an existing subscriber starts a brand-new checkout instead of managing the current one.

Requires an existing Stripe customer. Orgs that have never started billing have nothing to manage, so they get an actionable 400 pointing at /subscribe.

post/v1/organizations/billing/portal

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/organizations/billing/portal
  • Auth: HTTP bearer

Request body

return_urlstring nullable

URL Stripe redirects back to when the customer leaves the portal

Response

Successful Response

portal_urlstring required

Stripe-hosted billing portal URL (redirect the user here)

session_idstring required

Stripe billing portal session ID

Example response

{
  "portal_url": "https://billing.stripe.com/p/session/live_abc123",
  "session_id": "bps_live_abc123"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API