WePay logo
      Nothing Found

Get a billing statement

get/billing_statements/{id}

The GET /billing_statements/{id} call allows your platform to look up a single billing statement. 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
path Parameters
id
required
string [ 1 .. 255 ] characters
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
id
required
string
resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
billing_statements
path
required
string
required
object or null

Details the owner resource and owner path.

create_time
required
integer <int64> >= 0
total_fee_amount
required
integer

The total amount in fees that the merchant owes to the platform.

currency
required
string

ISO 4217 currency code. Currently, the only supported value is USD.

Value: Description
USD

United States Dollar

month
required
integer [ 1 .. 12 ]

Indicates the month for which the billing statement is calculated.

year
required
integer >= 0

Indicates the year in which the billing statement's month occurred.

api_version
required
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "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": 198904,
  • "currency": "USD",
  • "month": 9,
  • "year": 2019,
  • "api_version": "3.0"
}