Open the Stripe Customer Portal for the signed-in org

Available to an org owner or admin. Reachable even while the org's paid-plan access is expired for a payment problem, since it is the way out of a payment lapse.

POST /billing/portal

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Returns

url string

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/billing/portal" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch("https://api.scaffoldyourdocs.com/billing/portal", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/billing/portal",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={},
)

Response (shape)

{
  "url": "string"
}