Skip to main content

Fees

Generated HTTP reference for the 2 operations the published OpenAPI document describes under fees.

1 min read
View MarkdownEdit on GitHub

Fees

This page is generated from the published OpenAPI document. It is complete with respect to that document and says nothing about surfaces the document does not describe yet. See what is generated here for what that means.

Base URL: https://api.codespar.dev

Every operation below requires a Bearer token. See Authentication.

GET /v1/fees

GEThttps://api.codespar.dev/v1/fees

Which rate-card lanes are measured and charged for this org

Responses

StatusBodyDescription
200objectOK

Response 200

FieldTypeRequiredDescription
lanesobjectyes
periodstringyes
Example request
curl -X GET https://api.codespar.dev/v1/fees \
  -H "Authorization: Bearer $CODESPAR_API_KEY"
const res = await fetch("https://api.codespar.dev/v1/fees", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.CODESPAR_API_KEY}`,
  },
});

const data = await res.json();
Example response 200
application/json
{
  "period": "string",
  "lanes": {
    "movimentar": {
      "computed": true,
      "charging": true,
      "latest": {
        "period": "string",
        "consumerCount": 1,
        "movedMinor": 1,
        "freeTierAppliedMinor": 1,
        "billableMinor": 1,
        "refundCreditMinor": 1,
        "refundedCount": 1,
        "feeMinor": 1,
        "rateTier": "self_serve",
        "computedAt": "2026-01-15T12:00:00.000Z",
        "invoiced": true
      }
    },
    "faturar": {
      "computed": true,
      "charging": true,
      "latest": {
        "period": "string",
        "consumerCount": 1,
        "movedMinor": 1,
        "freeTierAppliedMinor": 1,
        "billableMinor": 1,
        "refundCreditMinor": 1,
        "refundedCount": 1,
        "feeMinor": 1,
        "rateTier": "self_serve",
        "computedAt": "2026-01-15T12:00:00.000Z",
        "invoiced": true
      }
    },
    "governar": {
      "computed": true,
      "charging": true,
      "latest": {
        "period": "string",
        "consumerCount": 1,
        "movedMinor": 1,
        "freeTierAppliedMinor": 1,
        "billableMinor": 1,
        "refundCreditMinor": 1,
        "refundedCount": 1,
        "feeMinor": 1,
        "rateTier": "self_serve",
        "computedAt": "2026-01-15T12:00:00.000Z",
        "invoiced": true
      }
    },
    "operar": {
      "computed": true,
      "charging": true,
      "latest": {
        "period": "string",
        "consumerCount": 1,
        "movedMinor": 1,
        "freeTierAppliedMinor": 1,
        "billableMinor": 1,
        "refundCreditMinor": 1,
        "refundedCount": 1,
        "feeMinor": 1,
        "rateTier": "self_serve",
        "computedAt": "2026-01-15T12:00:00.000Z",
        "invoiced": true
      }
    }
  }
}

GET /v1/fees/movimentar

GEThttps://api.codespar.dev/v1/fees/movimentar

The org's latest MOVIMENTAR-lane fee period (rate card v1)

Responses

StatusBodyDescription
200object,nullOK

Response 200

FieldTypeRequiredDescription
billableMinorintegeryes
computedAtstring (date-time)yes
consumerCountintegeryes
feeMinorintegeryes
freeTierAppliedMinorintegeryes
invoicedbooleanyes
movedMinorintegeryes
periodstringyes
rateTier"self_serve" | "commit_8bps" | "commit_6bps"yes
refundCreditMinorintegeryes
refundedCountintegeryes
Example request
curl -X GET https://api.codespar.dev/v1/fees/movimentar \
  -H "Authorization: Bearer $CODESPAR_API_KEY"
const res = await fetch("https://api.codespar.dev/v1/fees/movimentar", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.CODESPAR_API_KEY}`,
  },
});

const data = await res.json();
Example response 200
application/json
{
  "period": "string",
  "consumerCount": 1,
  "movedMinor": 1,
  "freeTierAppliedMinor": 1,
  "billableMinor": 1,
  "refundCreditMinor": 1,
  "refundedCount": 1,
  "feeMinor": 1,
  "rateTier": "self_serve",
  "computedAt": "2026-01-15T12:00:00.000Z",
  "invoiced": true
}
Fees | CodeSpar