Pluggy · Schema

Bill

Response with information related to a credit card bill

CompanyOpen FinanceBankingFinancial DataPaymentsBrazilFintech

Properties

Name Type Description
id string Primary identifier
dueDate string Due date of the bill, displayed for payment by the customer
billClosingDate stringnull Date when the bill was closed
totalAmount number Total bill amount
totalAmountCurrencyCode string Code referencing the currency of the bill
minimumPaymentAmount number Minimum payment amount of the bill
allowsInstallments boolean Indicates whether the bill allows installment payments (true) or not (false)
financeCharges array List of charges associated to the bill
payments array List of payments associated to the bill
View JSON Schema on GitHub

JSON Schema

pluggy-bill-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-bill-schema.json",
  "title": "Bill",
  "description": "Response with information related to a credit card bill",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pluggy-bill-api-openapi.yml#/components/schemas/Bill",
  "properties": {
    "id": {
      "type": "string",
      "description": "Primary identifier"
    },
    "dueDate": {
      "type": "string",
      "format": "date-time",
      "description": "Due date of the bill, displayed for payment by the customer"
    },
    "billClosingDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Date when the bill was closed"
    },
    "totalAmount": {
      "type": "number",
      "description": "Total bill amount"
    },
    "totalAmountCurrencyCode": {
      "type": "string",
      "description": "Code referencing the currency of the bill"
    },
    "minimumPaymentAmount": {
      "type": "number",
      "description": "Minimum payment amount of the bill"
    },
    "allowsInstallments": {
      "type": "boolean",
      "description": "Indicates whether the bill allows installment payments (true) or not (false)"
    },
    "financeCharges": {
      "type": "array",
      "description": "List of charges associated to the bill",
      "items": {
        "$ref": "#/$defs/BillFinanceCharge"
      }
    },
    "payments": {
      "type": "array",
      "description": "List of payments associated to the bill",
      "items": {
        "$ref": "#/$defs/BillPayment"
      }
    }
  },
  "type": "object",
  "required": [
    "id",
    "dueDate",
    "totalAmount",
    "totalAmountCurrencyCode",
    "financeCharges",
    "payments"
  ],
  "$defs": {
    "BillFinanceCharge": {
      "description": "Response with information related to a credit card bill finance charge",
      "properties": {
        "id": {
          "type": "string",
          "description": "Primary identifier"
        },
        "type": {
          "enum": [
            "LATE_PAYMENT_REMUNERATIVE_INTEREST",
            "LATE_PAYMENT_FEE",
            "LATE_PAYMENT_INTEREST",
            "IOF",
            "OTHER"
          ],
          "type": "string",
          "description": "Denomination of the charges that apply to the postpaid payment account bill"
        },
        "amount": {
          "type": "number",
          "description": "Amount charged for the charge/fee"
        },
        "currencyCode": {
          "type": "string",
          "description": "Code referencing the currency of the charge"
        },
        "additionalInfo": {
          "type": "string",
          "description": "Free field, mandatory to fill if 'OTHER' type of charge is selected"
        }
      },
      "type": "object",
      "required": [
        "id",
        "type",
        "amount",
        "currencyCode"
      ]
    },
    "BillPayment": {
      "description": "Response with information related to a credit card bill payment",
      "properties": {
        "id": {
          "type": "string",
          "description": "Primary identifier"
        },
        "valueType": {
          "enum": [
            "INSTALLMENT_PAYMENT",
            "FULL_PAYMENT",
            "OTHER_PAYMENT"
          ],
          "type": "string",
          "description": "Classifies the payment value type"
        },
        "paymentDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the payment was made"
        },
        "paymentMode": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "DEBIT_ACCOUNT",
            "BANK_SLIP",
            "PAYROLL_DEDUCTION",
            "PIX",
            null
          ],
          "description": "Payment mode used"
        },
        "amount": {
          "type": "number",
          "description": "Payment amount"
        },
        "currencyCode": {
          "type": "string",
          "description": "Code referencing the currency of the payment"
        }
      },
      "type": "object",
      "required": [
        "id",
        "valueType",
        "paymentDate",
        "amount",
        "currencyCode"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pluggy-bill"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.