APIReference

Billing API

Generated OpenAPI reference for the Billing API surface.

Overview

Billing endpoints are part of the public Everyn API. Organization-scoped human billing reads and owner/admin billing mutations.

Endpoints

The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.

The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.

Endpoint summary for quick scanning before using the generated reference:

MethodPathPurposeAuthenticationRequest body / schemaSuccess response / schemaErrors
POST/v1/billing/stripe/webhooksIngest Stripe Billing WebhookBearer token (BearerAuth)None.202 NoneAPI errors: 400, 401, 403, 404, 409, 429
GET/v1/organizations/{organization_id}/billingGet Billing OverviewBearer token (BearerAuth)None.200 application/json: BillingOverviewResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/cancellationDiscover Agreement CancellationBearer token (BearerAuth)None.200 application/json: CancellationDiscoveryNoneResponse or CancellationDiscoveryFoundResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/cancellationRequest Agreement CancellationBearer token (BearerAuth)application/json: CancellationRequestBody201 application/json: CancellationResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/cancellation/{cancellation_id}/withdrawalWithdraw Agreement CancellationBearer token (BearerAuth)application/json: CancellationWithdrawalRequestBody200 application/json: CancellationResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/historyList Billing HistoryBearer token (BearerAuth)None.200 application/json: BillingHistoryListResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/history/{history_item_id}Get Billing History DetailBearer token (BearerAuth)None.200 application/json: BillingHistoryDetailResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/paid-checkoutsStart Paid CheckoutBearer token (BearerAuth)application/json: PaidCheckoutStartRequestBody200 application/json: PaidCheckoutReconciledResponse
201 application/json: PaidCheckoutStartResponse
202 application/json: PaidCheckoutPreparingResponse		API errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/paid-checkouts/complete-returnComplete Paid Checkout ReturnBearer token (BearerAuth)application/json: PaidCheckoutCompleteReturnRequestBody200 application/json: PaidCheckoutStatusResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/paid-checkouts/{paid_checkout_intent_id}Get Paid Checkout StatusBearer token (BearerAuth)None.200 application/json: PaidCheckoutStatusResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/payment-method-setupsStart Payment Method SetupBearer token (BearerAuth)application/json: PaymentMethodSetupStartRequestBody or null201 application/json: PaymentMethodSetupStartResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/payment-method-setups/complete-returnComplete Payment Method Setup ReturnBearer token (BearerAuth)application/json: PaymentMethodSetupCompleteReturnRequestBody200 application/json: PaymentSetupStatusResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/payment-method-setups/{hosted_setup_intent_id}Get Payment Method Setup StatusBearer token (BearerAuth)None.200 application/json: PaymentSetupStatusResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/plan-transitionDiscover Plan TransitionBearer token (BearerAuth)None.200 application/json: PlanTransitionDiscoveryNoneResponse or PlanTransitionDiscoveryFoundResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/plan-transition-quoteGet Plan Transition QuoteBearer token (BearerAuth)None.200 application/json: PlanTransitionQuoteResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/plan-transitionsRequest Plan TransitionBearer token (BearerAuth)application/json: PlanTransitionRequestBody201 application/json: PlanTransitionStartResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/plan-transitions/complete-returnComplete Plan Transition ReturnBearer token (BearerAuth)application/json: PlanTransitionCompleteReturnRequestBody200 application/json: PlanTransitionResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/plan-transitions/{plan_transition_id}Get Plan Transition StatusBearer token (BearerAuth)None.200 application/json: PlanTransitionResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/portal-sessionsStart Billing Portal SessionBearer token (BearerAuth)None.201 application/json: BillingPortalSessionResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/recoveryGet Renewal RecoveryBearer token (BearerAuth)None.200 application/json: RenewalRecoveryResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/recovery/stop-to-freeStop Renewal Recovery To FreeBearer token (BearerAuth)application/json: RenewalRecoveryStopRequestBody200 application/json: RenewalRecoveryResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
PUT/v1/organizations/{organization_id}/billing/row-budgetChange Row BudgetBearer token (BearerAuth)application/json: RowBudgetChangeRequestBody200 application/json: RowBudgetChangeResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/statementsList Billing StatementsBearer token (BearerAuth)None.200 application/json: BillingStatementListResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/statements/{statement_id}Get Billing StatementBearer token (BearerAuth)None.200 application/json: BillingStatementDetailResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/top-up-receiptsList Top Up ReceiptsBearer token (BearerAuth)None.200 application/json: TopUpReceiptListResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/top-upsStart Top UpBearer token (BearerAuth)application/json: TopUpStartRequestBody201 application/json: TopUpIntentResponseAPI errors: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/top-ups/{top_up_intent_id}Get Top Up StatusBearer token (BearerAuth)None.200 application/json: TopUpIntentResponseAPI errors: 400, 401, 403, 404, 409, 422, 429

Loading API reference...

Alert Rules API

Generated OpenAPI reference for the Alert Rules API surface.

Dataset Uploads API

Generated OpenAPI reference for the Dataset Uploads API surface.