APIReferenz

Billing API

Generierte OpenAPI-Referenz für die Billing-API-Oberfläche.

Überblick

Billing-Endpoints gehören zur öffentlichen Everyn-API. Organization-scoped human billing reads and owner/admin billing mutations.

Endpunkte

Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag.

Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:

Fehler nutzen die PublicErrorEnvelope-Form mit einem X-Request-Id-Header. Die meisten Endpoints unten liefern 400, 401, 403, 404, 409, 422, 429; die wenigen Abweichungen listen ihre eigenen Statuscodes in der Tabelle, die sonst nur Erfolgs-Responses zeigt. Siehe API-Fehler für Envelope und Recovery-Muster.

MethodePfadZusammenfassungRequest BodyErfolgs-Response
POST/v1/billing/stripe/webhooksIngest Stripe Billing WebhookKeine.202 Keine
Fehler: 400, 401, 403, 404, 409, 429.
GET/v1/organizations/{organization_id}/billingGet Billing OverviewKeine.200 application/json: BillingOverviewResponse
GET/v1/organizations/{organization_id}/billing/cancellationDiscover Agreement CancellationKeine.200 application/json: CancellationDiscoveryNoneResponse or CancellationDiscoveryFoundResponse
POST/v1/organizations/{organization_id}/billing/cancellationRequest Agreement Cancellationapplication/json: CancellationRequestBody201 application/json: CancellationResponse
POST/v1/organizations/{organization_id}/billing/cancellation/{cancellation_id}/withdrawalWithdraw Agreement Cancellationapplication/json: CancellationWithdrawalRequestBody200 application/json: CancellationResponse
GET/v1/organizations/{organization_id}/billing/historyList Billing HistoryKeine.200 application/json: BillingHistoryListResponse
GET/v1/organizations/{organization_id}/billing/history/{history_item_id}Get Billing History DetailKeine.200 application/json: BillingHistoryDetailResponse
POST/v1/organizations/{organization_id}/billing/paid-checkoutsStart Paid Checkoutapplication/json: PaidCheckoutStartRequestBody200 application/json: PaidCheckoutReconciledResponse
201 application/json: PaidCheckoutStartResponse
202 application/json: PaidCheckoutPreparingResponse
POST/v1/organizations/{organization_id}/billing/paid-checkouts/complete-returnComplete Paid Checkout Returnapplication/json: PaidCheckoutCompleteReturnRequestBody200 application/json: PaidCheckoutStatusResponse
GET/v1/organizations/{organization_id}/billing/paid-checkouts/{paid_checkout_intent_id}Get Paid Checkout StatusKeine.200 application/json: PaidCheckoutStatusResponse
POST/v1/organizations/{organization_id}/billing/payment-method-setupsStart Payment Method Setupapplication/json: PaymentMethodSetupStartRequestBody or null201 application/json: PaymentMethodSetupStartResponse
POST/v1/organizations/{organization_id}/billing/payment-method-setups/complete-returnComplete Payment Method Setup Returnapplication/json: PaymentMethodSetupCompleteReturnRequestBody200 application/json: PaymentSetupStatusResponse
GET/v1/organizations/{organization_id}/billing/payment-method-setups/{hosted_setup_intent_id}Get Payment Method Setup StatusKeine.200 application/json: PaymentSetupStatusResponse
GET/v1/organizations/{organization_id}/billing/plan-transitionDiscover Plan TransitionKeine.200 application/json: PlanTransitionDiscoveryNoneResponse or PlanTransitionDiscoveryFoundResponse
GET/v1/organizations/{organization_id}/billing/plan-transition-quoteGet Plan Transition QuoteKeine.200 application/json: PlanTransitionQuoteResponse
POST/v1/organizations/{organization_id}/billing/plan-transitionsRequest Plan Transitionapplication/json: PlanTransitionRequestBody201 application/json: PlanTransitionStartResponse
POST/v1/organizations/{organization_id}/billing/plan-transitions/complete-returnComplete Plan Transition Returnapplication/json: PlanTransitionCompleteReturnRequestBody200 application/json: PlanTransitionResponse
GET/v1/organizations/{organization_id}/billing/plan-transitions/{plan_transition_id}Get Plan Transition StatusKeine.200 application/json: PlanTransitionResponse
POST/v1/organizations/{organization_id}/billing/portal-sessionsStart Billing Portal SessionKeine.201 application/json: BillingPortalSessionResponse
GET/v1/organizations/{organization_id}/billing/recoveryGet Renewal RecoveryKeine.200 application/json: RenewalRecoveryResponse
POST/v1/organizations/{organization_id}/billing/recovery/stop-to-freeStop Renewal Recovery To Freeapplication/json: RenewalRecoveryStopRequestBody200 application/json: RenewalRecoveryResponse
PUT/v1/organizations/{organization_id}/billing/row-budgetChange Row Budgetapplication/json: RowBudgetChangeRequestBody200 application/json: RowBudgetChangeResponse
GET/v1/organizations/{organization_id}/billing/statementsList Billing StatementsKeine.200 application/json: BillingStatementListResponse
GET/v1/organizations/{organization_id}/billing/statements/{statement_id}Get Billing StatementKeine.200 application/json: BillingStatementDetailResponse
GET/v1/organizations/{organization_id}/billing/top-up-receiptsList Top Up ReceiptsKeine.200 application/json: TopUpReceiptListResponse
POST/v1/organizations/{organization_id}/billing/top-upsStart Top Upapplication/json: TopUpStartRequestBody201 application/json: TopUpIntentResponse
GET/v1/organizations/{organization_id}/billing/top-ups/{top_up_intent_id}Get Top Up StatusKeine.200 application/json: TopUpIntentResponse

API-Referenz wird geladen...

Alert Rules API

Generierte OpenAPI-Referenz für die Alert Rules-API-Oberfläche.

Dataset Uploads API

Generierte OpenAPI-Referenz für die Dataset Uploads-API-Oberfläche.