Ctrl+K

List billing tasks

get/api/v2/admin/billing/tasks

Returns a list of billing tasks. Useful for determining the status of a billing task and obtaining relevant information to query the billing reports associated with it.

Query Parameters

  • bitgoOrgstring
    Filter by bitgoOrg
    Enum: BitGo%20Inc BitGo%20Trust BitGo%20New%20York BitGo%20Germany BitGo%20Switzerland BitGo%20Singapore
  • enterpriseIdstring
    Filter by enterprise public ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • pricingstring
    Filter by pricing plan public ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • startDatestring<date-time>
    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
    Filter reports by billing period that ends on or before a certain date (YYYY-MM).
    Example: 2021-09
    Pattern: ^\d{4}\-(0[1-9]|1[012])$

200 Response

tasks array[object]
id string required
Public ID of the billing task
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
state string required
Current state of the task object
Allowed values: pending started finished failed
updatedAt string <date-time>required
Date of most recent update to this task
pricingPlanId string
Optional pricing plan to use for all reports generated by this task
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
meta object required
An object containing metadata about this task
sendEmail boolean
Set to true if email notifications will be sent once this task is complete
newPlans boolean
Set to true if the billing worker should only bill enterprises with new pricing plans. Set to false if we should only bill enterprises with old pricing plans.
errors array[object] required
A list of billing errors, per enterprise to be billed, that were caught asynchronously during bill calculation
notes array[string]
List of notes that will be attached to each report linked to this billing task

400 Response

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