NativifyDocs

Create billing portal session

OpenAPI contract

Method
POST
Path
/api/v1/billing/portal
Security
jwtBearer (bearer)
Response status
200 400 401 403 429 500
Request and response schemas
JSON
{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Billing portal URL",
      "content": {
        "application/json": {}
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

POST /api/v1/billing/portal is JWT-only. It returns only { "redirectUrl": "..." }, a hosted Stripe Billing Portal session URL for the authenticated user. It does not change a subscription or payment method by itself.

Availability: source/config-verified. The URL requires a configured payment provider; no real portal session was created to verify this documentation. Provider webhooks are intentionally outside the public API Reference.

http
POST /api/v1/billing/portal
Authorization: Bearer <access token>