Skip to content

Ramp: Billing statement schemas

3 Ramp schemas with complete fields and constraints.

← Billing statement operations · All schemas

List billing statements — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List billing statements — response body — data item
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, List billing statements — response body — data item

List billing statements — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Fetch a payment — response body — amount
The total amount due for this billing statement.
Read only: true
idstringRequired within parentUnique identifier of the billing statement.
Format: uuid
statement_periodModelRequired within parentExpand List billing statements — response body — data item statement period
The billing statement period date range.
Read only: true
statement_urlJSONRequired within parent
statement_url (anyOf 1)stringAlternativePresigned URL to download the billing statement PDF, or null if unavailable.
Format: url
Read only: true
statement_url (anyOf 2)nullAlternative

Referenced models: List billing statements — response body — data item statement period, Fetch a payment — response body — amount

List billing statements — response body — data item statement period

FieldTypePresenceDescription and constraints
$objectRoot
endJSONRequired within parent
end (anyOf 1)stringAlternativeEnd date of the billing statement period, or null if the period is still open.
Default: null
Format: date
end (anyOf 2)nullAlternative
startstringRequired within parentStart date of the billing statement period.
Format: date

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.