Skip to main content
GET
List projected

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

subscriptionId
string
required

The subscription to project invoices for Unique identifier for a subscription

Pattern: ^sub_[a-zA-Z0-9]+$
from
string<date-time>

Start of the range of invoice moments, inclusive. Defaults to now. A value before now is treated as now.

to
string<date-time>

End of the range of invoice moments, exclusive. Defaults to one month after from. Must be after from and at most one year after now.

limit
integer
default:10

Maximum number of invoices to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of invoices to skip for pagination

Required range: 0 <= x <= 10000

Response

Projected invoices ordered by invoice moment, earliest first

object
enum<string>
required
Available options:
list
data
object[]
required
pagination
object
required

Offset-based pagination response.