WePay logo
      Nothing Found

Get a collection of billing statements

get/billing_statements

The GET /billing_statements call allows your platform to look up a collection of billing statements. Billing statements provide aggregate transaction amounts for an account in a certain time period. Be sure to subscribe to the billing_statements.created Notification event topic to programmatically incorporate new Billing Statements. Learn more about MIC+.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements starting from this page. If specified, no other query parameters can be specified.

page_size
integer [ 1 .. 500 ]
Default: 10

Maximum number of items per page of results.

account_id
string

All billing statements owned by an account.

currency
string
Default: "USD"

Currency associated with the account.

Enum: Description
USD

United States Dollar

CAD

Canadian Dollar

… 1 more
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
next
required
string or null
previous
required
string or null
required
Array of objects or null unique
api_version
required
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "previous": "/billing_statements?page=aaabc123def456",
  • "next": "/billing_statements?page=cccde123fgh456",
  • "results": [
    • {
      • "id": "c4a1abf1-34ac-40e8-bdba-5649f0665421",
      • "resource": "billing_statements",
      • "path": "/billing_statements/c4a1abf1-34ac-40e8-bdba-5649f0665421",
      • "owner": {
        • "id": "c4a1abf1-34ac-40e8-bdba-5649f0643043",
        • "resource": "accounts",
        • "path": "/accounts/c4a1abf1-34ac-40e8-bdba-5649f0643043"
        },
      • "create_time": 1546300800,
      • "total_fee_amount": 2300000,
      • "currency": "USD",
      • "month": 1,
      • "year": 2019,
      • "api_version": "3.0"
      },
    • {
      • "id": "85a84216-c2d5-11e9-9cb5-2a2ae2dbcce4",
      • "resource": "billing_statements",
      • "path": "/billing_statements/85a84216-c2d5-11e9-9cb5-2a2ae2dbcce4",
      • "owner": {
        • "id": "c4a1abf1-34ac-40e8-bdba-5649f0643043",
        • "resource": "accounts",
        • "path": "/accounts/c4a1abf1-34ac-40e8-bdba-5649f0643043"
        },
      • "create_time": 1548979200,
      • "total_fee_amount": 1320000,
      • "currency": "USD",
      • "month": 2,
      • "year": 2019,
      • "api_version": "3.0"
      }
    ],
  • "api_version": "3.0"
}