auxiliaryResults

Get the auxiliary results produced when costing a charge.

Page with offset and first: start at offset: 0 and increment offset by the page size each request, keeping a separate offset per charge when fetching several via field aliases. Stop a charge once it returns an empty page or pageInfo.hasNextPage is false.

totalCount is the number remaining from the given offset, so read it at offset: 0 for the full total. Prefer offset over cursor pagination: an exhausted charge returns a null endCursor that, fed back as after, restarts it from the beginning, so cursors can silently repeat results across charges. Do not combine offset with after.

Arguments

after : String

before : String

chargeId : ID!


            required

The ID of the charge to get auxiliary results for.

first : Int

last : Int

name : String

Only return auxiliary results with this name.

offset : Int

periodEnd : DateTime

Only return auxiliary results whose period falls within this window. Must be given together with periodStart.

periodStart : DateTime

Only return auxiliary results whose period falls within this window. Must be given together with periodEnd.

Returns

AuxiliaryResultConnection

Pagination for a charge's auxiliary results.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can query billing information

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query AuxiliaryResults(
  $after: String,
  $before: String,
  $chargeId: ID!,
  $first: Int,
  $last: Int,
  $name: String,
  $offset: Int,
  $periodEnd: DateTime,
  $periodStart: DateTime
) {
  auxiliaryResults(
    after: $after,
    before: $before,
    chargeId: $chargeId,
    first: $first,
    last: $last,
    name: $name,
    offset: $offset,
    periodEnd: $periodEnd,
    periodStart: $periodStart
  ) {
    edgeCount
    edges {
      ...AuxiliaryResultEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "chargeId": "41343819",
  "first": 10,
  "last": 10,
  "name": "magazine-concern-fish-throw-turn",
  "offset": 88,
  "periodEnd": "2006-03-13T00:55:52.785301+00:00",
  "periodStart": "1982-10-14T05:57:00.691698+00:00"
}

{
  "data": {
    "auxiliaryResults": {
      "edgeCount": 41,
      "edges": [AuxiliaryResultEdge],
      "pageInfo": PageInfo,
      "totalCount": 64
    }
  }
}