NativifyDocs

Create subscription checkout

OpenAPI contract

Method
POST
Path
/api/v1/billing/checkout/subscription
Security
jwtBearer (bearer)
Response status
200 400 401 403 429 500
Request and response schemas
JSON
{
  "requestBody": {
    "application/json": {
      "$ref": "#/components/schemas/PlanRequest"
    }
  },
  "responses": {
    "200": {
      "description": "Checkout 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/checkout/subscription is JWT-only. Send a nonblank planCode for an active plan that has a configured Stripe price; an optional Idempotency-Key is forwarded to Stripe. The response is only { "redirectUrl": "..." }, a hosted Checkout session URL. It does not itself create or activate a subscription.

Availability: source/config-verified. This page documents the server path and configuration behavior, not a completed payment. Stripe confirmation and subscription updates are handled by the provider webhook; that webhook is intentionally outside the public API Reference.

http
POST /api/v1/billing/checkout/subscription
Authorization: Bearer <access token>
Content-Type: application/json
Idempotency-Key: <unique key>

{"planCode":"PRO"}