List all invoices

Lists all the invoices from all the organizations in a Frontier instance. It can be filtered by organization.

Query Parameters

org_id string

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

invoices object[]
Array [
id string
customer_id string
provider_id string
state string
currency string
amount int64
hosted_url string
due_date date-time
effective_at date-time
The date when this invoice is in effect.
period_start_at date-time
period_end_at date-time
metadata object
created_at date-time
]

{
  "invoices": [
    {
      "id": "string",
      "customer_id": "string",
      "provider_id": "string",
      "state": "string",
      "currency": "string",
      "amount": "string",
      "hosted_url": "string",
      "due_date": "2024-04-01T04:39:08.686Z",
      "effective_at": "2024-04-01T04:39:08.686Z",
      "period_start_at": "2024-04-01T04:39:08.686Z",
      "period_end_at": "2024-04-01T04:39:08.686Z",
      "metadata": {},
      "created_at": "2024-04-01T04:39:08.686Z"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...