Skip to content

Ramp: List billing statements

Ramp billingStatement.getBillingStatementListResource: arguments, response, policy and SDK examples.

← Billing statement operations · Get started

Operation ramp.get_billing_statement_list_resource

Provider route: GET /developer/v1/billing/statements. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["billingStatement"]["getBillingStatementListResource"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.billingStatement.getBillingStatementListResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.billing_statement.get_billing_statement_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.statement_period_endJSONOptional
query.statement_period_end (anyOf 1)stringAlternativeDefault: null
Format: date
query.statement_period_end (anyOf 2)nullAlternative
query.statement_period_startJSONOptional
query.statement_period_start (anyOf 1)stringAlternativeDefault: null
Format: date
query.statement_period_start (anyOf 2)nullAlternative
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List billing statements — response body

Referenced models: List billing statements — response body

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 bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
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
Fetch a payment — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentThe currency of the amount in ISO 4217 format (e.g. USD).
Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
valueJSONRequired within parent
value (anyOf 1)integerAlternativeThe non-negative amount in the smallest denomination of the currency (e.g. cents for USD).
Minimum: 0
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: ramp.get_billing_statement_list_resource. Catalog operation: get_billing_statement_list_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["billing_statements:read"]

Official provider source

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.