APIReferenz

Billing API

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

Überblick

Billing-Endpoints gehören zur öffentlichen Everyn-API. Organisationsbezogene Abfragen zur menschlichen Abrechnung sowie Abrechnungsänderungen durch Eigentümer und Administratoren.

Endpunkte

Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag. Die statische Zusammenfassung hält Zweck, Authentifizierung, Schemanamen und Hinweise zur API-Fehlerbehandlung verfügbar, bevor die interaktive Referenz geladen ist.

Die Details unten sind statisches HTML aus demselben OpenAPI-Schema und bleiben ohne clientseitiges JavaScript lesbar. Die interaktive Komponente danach ergänzt ausklappbare Beispiele und Schema-Browsing.

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

MethodePfadZweckAuthentifizierungRequest Body / SchemaErfolgs-Response / SchemaFehler
POST/v1/billing/stripe/webhooksStripe-Abrechnungs-Webhook empfangenBearer-Token (BearerAuth)Keine.202 KeineAPI-Fehler: 400, 401, 403, 404, 409, 429
GET/v1/organizations/{organization_id}/billingAbrechnungsübersicht abrufenBearer-Token (BearerAuth)Keine.200 application/json: BillingOverviewResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/cancellationMöglichkeiten zur Vertragskündigung ermittelnBearer-Token (BearerAuth)Keine.200 application/json: CancellationDiscoveryNoneResponse oder CancellationDiscoveryFoundResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/cancellationVertragskündigung anfordernBearer-Token (BearerAuth)application/json: CancellationRequestBody201 application/json: CancellationResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/cancellation/{cancellation_id}/withdrawalVertragskündigung zurücknehmenBearer-Token (BearerAuth)application/json: CancellationWithdrawalRequestBody200 application/json: CancellationResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/historyAbrechnungshistorie auflistenBearer-Token (BearerAuth)Keine.200 application/json: BillingHistoryListResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/history/{history_item_id}Detail der Abrechnungshistorie abrufenBearer-Token (BearerAuth)Keine.200 application/json: BillingHistoryDetailResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/paid-checkoutsBezahlten Checkout startenBearer-Token (BearerAuth)application/json: PaidCheckoutStartRequestBody200 application/json: PaidCheckoutReconciledResponse
201 application/json: PaidCheckoutStartResponse
202 application/json: PaidCheckoutPreparingResponse
API-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/paid-checkouts/complete-returnRückgabe des bezahlten Checkouts abschließenBearer-Token (BearerAuth)application/json: PaidCheckoutCompleteReturnRequestBody200 application/json: PaidCheckoutStatusResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/paid-checkouts/{paid_checkout_intent_id}Status des bezahlten Checkouts abrufenBearer-Token (BearerAuth)Keine.200 application/json: PaidCheckoutStatusResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/payment-method-setupsEinrichtung der Zahlungsmethode startenBearer-Token (BearerAuth)application/json: PaymentMethodSetupStartRequestBody oder null201 application/json: PaymentMethodSetupStartResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/payment-method-setups/complete-returnRückgabe der Einrichtung der Zahlungsmethode abschließenBearer-Token (BearerAuth)application/json: PaymentMethodSetupCompleteReturnRequestBody200 application/json: PaymentSetupStatusResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/payment-method-setups/{hosted_setup_intent_id}Status der Einrichtung der Zahlungsmethode abrufenBearer-Token (BearerAuth)Keine.200 application/json: PaymentSetupStatusResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/plan-transitionPlanwechsel ermittelnBearer-Token (BearerAuth)Keine.200 application/json: PlanTransitionDiscoveryNoneResponse oder PlanTransitionDiscoveryFoundResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/plan-transition-quoteAngebot für Planwechsel abrufenBearer-Token (BearerAuth)Keine.200 application/json: PlanTransitionQuoteResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/plan-transitionsPlanwechsel anfordernBearer-Token (BearerAuth)application/json: PlanTransitionRequestBody201 application/json: PlanTransitionStartResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/plan-transitions/complete-returnRückgabe des Planwechsels abschließenBearer-Token (BearerAuth)application/json: PlanTransitionCompleteReturnRequestBody200 application/json: PlanTransitionResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/plan-transitions/{plan_transition_id}Status des Planwechsels abrufenBearer-Token (BearerAuth)Keine.200 application/json: PlanTransitionResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/portal-sessionsAbrechnungsportal-Sitzung startenBearer-Token (BearerAuth)Keine.201 application/json: BillingPortalSessionResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/recoveryInformationen zur Erneuerungserholung abrufenBearer-Token (BearerAuth)Keine.200 application/json: RenewalRecoveryResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/recovery/stop-to-freeErneuerung auf den kostenlosen Plan stoppenBearer-Token (BearerAuth)application/json: RenewalRecoveryStopRequestBody200 application/json: RenewalRecoveryResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
PUT/v1/organizations/{organization_id}/billing/row-budgetZeilenbudget ändernBearer-Token (BearerAuth)application/json: RowBudgetChangeRequestBody200 application/json: RowBudgetChangeResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/statementsAbrechnungsbelege auflistenBearer-Token (BearerAuth)Keine.200 application/json: BillingStatementListResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/statements/{statement_id}Abrechnungsbeleg abrufenBearer-Token (BearerAuth)Keine.200 application/json: BillingStatementDetailResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/top-up-receiptsAufstockungsbelege auflistenBearer-Token (BearerAuth)Keine.200 application/json: TopUpReceiptListResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
POST/v1/organizations/{organization_id}/billing/top-upsAufstockung startenBearer-Token (BearerAuth)application/json: TopUpStartRequestBody201 application/json: TopUpIntentResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429
GET/v1/organizations/{organization_id}/billing/top-ups/{top_up_intent_id}Status der Aufstockung abrufenBearer-Token (BearerAuth)Keine.200 application/json: TopUpIntentResponseAPI-Fehler: 400, 401, 403, 404, 409, 422, 429

API-Referenz wird geladen...