Ctrl+K

List billing reports

get/api/v2/admin/billing/reports

Returns a list of billing report IDs and metadata.
Returned items can be filtered with query parameters. If no parameters are provided, returns the most recent reports in descending order of creation date.

Query Parameters

  • bitgoOrgstring
    Filter by bitgoOrg
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
  • enterpriseIdstring
    Filter by enterprise public ID
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • pricingPlanIdstring
    Filter by pricing plan public ID
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • billingPeriodstring
  • startDatestring<date>
    Filter reports by billing period that starts on or after a certain date (YYYY-MM).
    Example: 2021-01
    Pattern: ^\d{4}\-(0[1-9]|1[012])$
  • endDatestring<date>
    Filter reports by billing period that ends on or before a certain date (YYYY-MM).
    Example: 2021-01
    Pattern: ^\d{4}\-(0[1-9]|1[012])$
  • invoiceIdstring
    Filter reports by an invoice ID. Will return all reports used to calculate the invoice.
    Example: T2021090001cd39dc93
  • typestring
    Enum: holdings holdingsByWallet holdingsByAddress v1Wallet v2Wallet allWallets transactions trades quarterly staking organizationHoldings organizationHoldingsByAddress organizationTransactions organizationTrades organizationStaking

200 Response

reports array[object] required
id string required
The report's public ID
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
billingTaskId string required
The billing task ID
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
userId string required
Public ID of the admin user who created this task
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string required
Allowed values: aum txn aggregate
created string <date>required
Timestamp of when this report was created
bitgoOrg string required
BitGo Organization related to this entity
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
enterpriseId string required
Public ID of the enterprise this report was generated for
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pricingPlanId string required
Public ID of the pricing plan used to generate this report
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
month number required
The billing period month (MM)
year number required
The billing period year (YYYY)
s3Bucket string required
The S3 bucket this report was saved to
s3File string required
The S3 filename this report was saved as
invoiceId string required
Invoice ID that this report relates to. Will not be set on an aggregate report
notes array[string] required
List of notes that will be attached to each report linked to this billing task.
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
date string required

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id