API Reference

Invoice API Documentation

Create Invoice

POST /api/invoice

Create a new invoice.

Request Body (application/json)

{
  "recipient": "string",
  "rate": 10,
  "period": "PerMonth"
}

  • recipient — recipient address (string)

  • rate — subscription rate/amount (number)

  • period — subscription period (enum: PerDay, PerWeek, PerMonth, PerYear)

Responses

  • 200 OK — invoice successfully created

  • 400 Bad Request — validation error

{
  "type": "string",
  "title": "string",
  "status": "string",
  "detail": "string",
  "instance": "string"
}

  • 401 Unauthorized — authorization error

  • 500 Internal Server Error — internal server error

Get Invoice by ID

GET /api/invoice/{id}

Retrieve information about an invoice.

Path Parameters

  • id (string, required) — invoice identifier

Example Response

Responses

  • 200 OK — invoice found

  • 404 Not Found — invoice not found

  • 500 Internal Server Error — internal server error

RatePeriod Enum

The period field supports the following values:

  • PerDay

  • PerWeek

  • PerMonth

  • PerYear

PreviousOverview

Last updated