Ramp: Billing statement schemas
3 Ramp schemas with complete fields and constraints.
← Billing statement operations · All schemas
List billing statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List billing statements — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Fetch a payment — response body — amount The total amount due for this billing statement. Read only: true |
id | string | Required within parent | Unique identifier of the billing statement. Format: uuid |
statement_period | Model | Required within parent | Expand List billing statements — response body — data item statement period The billing statement period date range. Read only: true |
statement_url | JSON | Required within parent | |
statement_url (anyOf 1) | string | Alternative | Presigned URL to download the billing statement PDF, or null if unavailable. Format: url Read only: true |
statement_url (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end | JSON | Required within parent | |
end (anyOf 1) | string | Alternative | End date of the billing statement period, or null if the period is still open. Default: null Format: date |
end (anyOf 2) | null | Alternative | |
start | string | Required within parent | Start date of the billing statement period. Format: date |