Skip to main content
GET
Get revenue schedule for a customer

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01

Path Parameters

id
string
required

Unique identifier for the customer

Query Parameters

currency
string
required

Target currency for conversion. Uses the entity's default if not specified.

Example:

"USD"

interval
enum<string>
required

Time interval for schedule entries

Available options:
daily,
monthly
Example:

"monthly"

Response

Success

currency
string
required

ISO 4217 currency code

Example:

"USD"

end_date
string<date-time>
required

End date of the schedule

Example:

"2027-01-01T00:00:00Z"

entries
object[]
required

Chronologically ordered schedule entries

interval
enum<string>
required

Time interval of entries

Available options:
daily,
monthly
Example:

"monthly"

start_date
string<date-time>
required

Start date of the schedule

Example:

"2026-01-01T00:00:00Z"