AlmondTill/G3N API

On this page

giveBack

query · in the family Billing and the wallet

What it does

Your Stripe give-back standing — the loyalty clock, the tier you have earned, and every month the program has given back, with the volume and rate on every row.

The caller group's Stripe revshare give-back standing. The report = the derived tenure clock + the earned tier + the next rung + the earned USD ledger (NEWEST-FIRST + bounded — the affiliateAccruals page shape). SELF-group BY CONSTRUCTION (no target arg). Requires authentication. Template class A16_BILLING (hand-derived v91).

What happens

Reads only.

Who may call it

Capability area: Billing and the wallet — Your platform bill, token purchases and the usage and cost reads.

Arguments

NameTypeRequiredNotes
limitIntnoHow many records to answer at most; a page may hold fewer.
beforeIDnoNo further notes.

Returns

GiveBackReport GiveBackReport! — The caller group's give-back standing (the program's merchant-visible transparency surface): the derived tenure clock, the earned tier, the next rung, and the earned ledger. Figures are as of computedThroughMonth — the last CLOSED month the billing engine decided.

Example request

query ExampleGiveBack($limit: Int) {
  giveBack(limit: $limit) {
    convertedFrom
    revokedAt
    revokedReason
    tenureMonths
    effectiveTenureMonths
    basis
    tierBp
    nextTierAtMonths
    nextTierBp
    computedThroughMonth
  }
}

Variables:

{
  "limit": 1
}

Example response

{
  "data": {
    "giveBack": {
      "convertedFrom": "<converted from>",
      "revokedAt": "2027-01-31T00:00:00.000Z",
      "revokedReason": "<revoked reason>",
      "tenureMonths": 1,
      "effectiveTenureMonths": 1,
      "basis": "<basis>",
      "tierBp": 1,
      "nextTierAtMonths": 1,
      "nextTierBp": 1,
      "computedThroughMonth": "<computed through month>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer