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.
Endpoint summary for quick scanning before using the generated reference:
Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.
| Method | Path | Summary | Request body | Success response |
|---|---|---|---|---|
POST | /v1/billing/stripe/webhooks | Ingest Stripe Billing Webhook | None. | 202 NoneErrors: 400, 401, 403, 404, 409, 429. |
GET | /v1/organizations/{organization_id}/billing | Get Billing Overview | None. | 200 application/json: BillingOverviewResponse |
GET | /v1/organizations/{organization_id}/billing/cancellation | Discover Agreement Cancellation | None. | 200 application/json: CancellationDiscoveryNoneResponse or CancellationDiscoveryFoundResponse |
POST | /v1/organizations/{organization_id}/billing/cancellation | Request Agreement Cancellation | application/json: CancellationRequestBody | 201 application/json: CancellationResponse |
POST | /v1/organizations/{organization_id}/billing/cancellation/{cancellation_id}/withdrawal | Withdraw Agreement Cancellation | application/json: CancellationWithdrawalRequestBody | 200 application/json: CancellationResponse |
GET | /v1/organizations/{organization_id}/billing/history | List Billing History | None. | 200 application/json: BillingHistoryListResponse |
GET | /v1/organizations/{organization_id}/billing/history/{history_item_id} | Get Billing History Detail | None. | 200 application/json: BillingHistoryDetailResponse |
POST | /v1/organizations/{organization_id}/billing/paid-checkouts | Start Paid Checkout | application/json: PaidCheckoutStartRequestBody | 200 application/json: PaidCheckoutReconciledResponse201 application/json: PaidCheckoutStartResponse202 application/json: PaidCheckoutPreparingResponse |
POST | /v1/organizations/{organization_id}/billing/paid-checkouts/complete-return | Complete Paid Checkout Return | application/json: PaidCheckoutCompleteReturnRequestBody | 200 application/json: PaidCheckoutStatusResponse |
GET | /v1/organizations/{organization_id}/billing/paid-checkouts/{paid_checkout_intent_id} | Get Paid Checkout Status | None. | 200 application/json: PaidCheckoutStatusResponse |
POST | /v1/organizations/{organization_id}/billing/payment-method-setups | Start Payment Method Setup | application/json: PaymentMethodSetupStartRequestBody or null | 201 application/json: PaymentMethodSetupStartResponse |
POST | /v1/organizations/{organization_id}/billing/payment-method-setups/complete-return | Complete Payment Method Setup Return | application/json: PaymentMethodSetupCompleteReturnRequestBody | 200 application/json: PaymentSetupStatusResponse |
GET | /v1/organizations/{organization_id}/billing/payment-method-setups/{hosted_setup_intent_id} | Get Payment Method Setup Status | None. | 200 application/json: PaymentSetupStatusResponse |
GET | /v1/organizations/{organization_id}/billing/plan-transition | Discover Plan Transition | None. | 200 application/json: PlanTransitionDiscoveryNoneResponse or PlanTransitionDiscoveryFoundResponse |
GET | /v1/organizations/{organization_id}/billing/plan-transition-quote | Get Plan Transition Quote | None. | 200 application/json: PlanTransitionQuoteResponse |
POST | /v1/organizations/{organization_id}/billing/plan-transitions | Request Plan Transition | application/json: PlanTransitionRequestBody | 201 application/json: PlanTransitionStartResponse |
POST | /v1/organizations/{organization_id}/billing/plan-transitions/complete-return | Complete Plan Transition Return | application/json: PlanTransitionCompleteReturnRequestBody | 200 application/json: PlanTransitionResponse |
GET | /v1/organizations/{organization_id}/billing/plan-transitions/{plan_transition_id} | Get Plan Transition Status | None. | 200 application/json: PlanTransitionResponse |
POST | /v1/organizations/{organization_id}/billing/portal-sessions | Start Billing Portal Session | None. | 201 application/json: BillingPortalSessionResponse |
GET | /v1/organizations/{organization_id}/billing/recovery | Get Renewal Recovery | None. | 200 application/json: RenewalRecoveryResponse |
POST | /v1/organizations/{organization_id}/billing/recovery/stop-to-free | Stop Renewal Recovery To Free | application/json: RenewalRecoveryStopRequestBody | 200 application/json: RenewalRecoveryResponse |
PUT | /v1/organizations/{organization_id}/billing/row-budget | Change Row Budget | application/json: RowBudgetChangeRequestBody | 200 application/json: RowBudgetChangeResponse |
GET | /v1/organizations/{organization_id}/billing/statements | List Billing Statements | None. | 200 application/json: BillingStatementListResponse |
GET | /v1/organizations/{organization_id}/billing/statements/{statement_id} | Get Billing Statement | None. | 200 application/json: BillingStatementDetailResponse |
GET | /v1/organizations/{organization_id}/billing/top-up-receipts | List Top Up Receipts | None. | 200 application/json: TopUpReceiptListResponse |
POST | /v1/organizations/{organization_id}/billing/top-ups | Start Top Up | application/json: TopUpStartRequestBody | 201 application/json: TopUpIntentResponse |
GET | /v1/organizations/{organization_id}/billing/top-ups/{top_up_intent_id} | Get Top Up Status | None. | 200 application/json: TopUpIntentResponse |
Loading API reference...