Create billing portal session

POST /api/billing-portal

Returns a Stripe Billing Portal URL where the user can view invoice history and manage payment methods.

Responses

url string (uri) Stripe Billing Portal redirect URL

errorrequired object

coderequired string Machine-readable error code UNAUTHORIZEDFORBIDDENNOT_FOUNDVALIDATION_FAILEDRATE_LIMITEDSLUG_TAKENSLUG_RESERVEDDOMAIN_IN_USEAPP_LIMIT_REACHEDSUBSCRIPTION_REQUIREDSUBSCRIPTION_EXISTSNO_PAYMENT_METHODNO_ACTIVE_SUBSCRIPTIONNOT_CANCELINGALREADY_CANCELINGSUBSCRIPTION_CANCELINGSAME_PLANCARD_ERRORPAYMENT_ERRORNO_STRIPE_CUSTOMERCERT_CREATION_FAILEDDEPLOY_FAILEDAPI_KEY_LIMIT_REACHEDINVALID_IDEMPOTENCY_KEYIDEMPOTENCY_KEY_REUSEINTERNAL_ERROR

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

Language

URL

POST https://api.orbitkit.io/api/billing-portal

curl -X POST "https://api.orbitkit.io/api/billing-portal" \
  -H "Authorization: Bearer $ORBITKIT_API_KEY"

const response = await fetch("https://api.orbitkit.io/api/billing-portal", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + apiKey,
  },
});

const data = await response.json();
console.log(data);

var request = URLRequest(url: URL(string: "https://api.orbitkit.io/api/billing-portal")!)
request.httpMethod = "POST"
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let json = try JSONSerialization.jsonObject(with: data)
print(json)

200

{
  "url": "https://example.com"
}

401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token",
    "docUrl": "https://orbitkit.io/api/errors/#unauthorized"
  }
}

404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "No billing account found"
  }
}