Resources
OpenAPI and schemas
Machine-readable descriptions of the API, generated from the same source as these pages.
OpenAPI document#
openapi/flux-integration-v1.json (OpenAPI 3.0) describes every endpoint, parameter, body and response on this site. Import it into Postman or Insomnia, or generate a client from it.
Set the server URL to your environment's base URL after importing, and add the header Authorization: ApiKey {{FLUX_API_KEY}}.
Object schemas#
JSON Schema (draft 2020-12) for each object the API returns or accepts.
Checkout.jsonContactInput.jsonCreateInvoiceRequest.jsonCurrencyTotals.jsonCustomer.jsonCustomerContact.jsonCustomerInput.jsonDelivery.jsonEnrollment.jsonEnrollmentEvent.jsonError.jsonEventEnvelope.jsonInvoice.jsonInvoiceLine.jsonInvoiceLineInput.jsonLinks.jsonPayment.jsonPaymentInitiated.jsonPaymentOutcome.jsonPaymentRefunded.jsonReceipt.jsonReceiptEvent.jsonStatement.jsonWebhookEndpoint.jsonWebhookEndpointInput.jsonWebhookTest.json
Event schemas#
One schema per webhook event type: the envelope with its data.object.
customer.created.jsoncustomer.updated.jsonenrollment.cycle_due.jsonenrollment.ended.jsonenrollment.started.jsoninvoice.approved.jsoninvoice.awaiting_final_approval.jsoninvoice.created.jsoninvoice.due_soon.jsoninvoice.issued.jsoninvoice.overdue.jsoninvoice.paid.jsoninvoice.payment_review.jsoninvoice.returned.jsoninvoice.submitted.jsoninvoice.updated.jsoninvoice.voided.jsonpayment.failed.jsonpayment.initiated.jsonpayment.refunded.jsonpayment.succeeded.jsonreceipt.issued.jsonwebhook.test.json