List billing statements

List billing statement resources.

---

Endpoint

GET /billing_statements

Sample code

curl

curl --location 'https://api.payrexhq.com/billing_statements' \
  -u replace_with_secret_api_key: \
  --data-urlencode 'limit=10'

Node

const client = require('payrex-node')('insert your PayRex Secret API key.');

// Return 10 records 
const billingStatements = await client.billingStatements.list({
  limit: 10,
});

PHP

$client = new \Payrex\PayrexClient('insert your PayRex Secret API key.');

// Return 10 records
$billingStatements = $client->billingStatements->list([
  limit: 10
]);

Python

from payrex import Client as PayrexClient

client = PayrexClient('insert your PayRex Secret API key.')

# Return 10 records 
billing_statements = client.billing_statements.list(
    {
        'limit': 10
    }
)

Ruby

client = Payrex::Client.new("insert your PayRex Secret API key.")

# Return 10 records
billing_statements = client.billing_statements.list(
  limit: 10
)

Parameters

limit optional

Limits the number of resources returned by the endpoint. The minimum amount is 1, and the maximum is 100.

---

before optional

A cursor used in pagination. before is a resource ID that defines your place in the list. For example, if you call a list request and receive 10 resources, starting with bstm_1234, your subsequent calls can include before=bstm_1234 to fetch the list's previous page.

---

after optional

A cursor used in pagination. after is a resource ID that defines your place in the list. For example, if you call a list request and receive 10 resources ending with bstm_1234, your subsequent calls can include after=bstm_1234 to fetch the next page of the list.

Returns

Returns a paginated list of Billing Statement resources.