Get upcoming invoice
Get the upcoming invoice of a billing account.
Path Parameters
org_id string required
billing_id string required
ID of the billing account to get the upcoming invoice for
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
invoice object
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
customer object
id string
org_id string
name string
email string
phone string
address object
line1 string
line2 string
city string
state string
postal_code string
country string
provider_id string
provider string
currency string
state string
tax_data object[]
type tax type like "vat", "gst", "sales_tax" or if it's
provider specific us_ein, uk_vat, in_gst, etc
id unique identifier provided by the tax agency
metadata object
created_at date-time
updated_at date-time
organization object
id string
name string
title string
metadata object
created_at date-time
The time the organization was created.
updated_at date-time
The time the organization was last updated.
state string
The state of the organization (enabled or disabled).
avatar string
The base64 encoded image string of the organization avatar. Should be less than 2MB.
{
"invoice": {
"id": "string",
"customer_id": "string",
"provider_id": "string",
"state": "string",
"currency": "string",
"amount": "string",
"hosted_url": "string",
"due_date": "2024-07-13T09:54:48.245Z",
"effective_at": "2024-07-13T09:54:48.245Z",
"period_start_at": "2024-07-13T09:54:48.245Z",
"period_end_at": "2024-07-13T09:54:48.245Z",
"metadata": {},
"created_at": "2024-07-13T09:54:48.245Z",
"customer": {
"id": "string",
"org_id": "string",
"name": "string",
"email": "string",
"phone": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"provider_id": "string",
"provider": "string",
"currency": "string",
"state": "string",
"tax_data": [
{
"type": "string",
"id": "string"
}
],
"metadata": {},
"created_at": "2024-07-13T09:54:48.245Z",
"updated_at": "2024-07-13T09:54:48.245Z",
"organization": {
"id": "string",
"name": "string",
"title": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"state": "enabled",
"avatar": "string"
}
}
}
}
Bad Request - The request was malformed or contained invalid parameters.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@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
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@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
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Loading...