PayPal · Schema

Capture Identifier

The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.

BillingCommerceDisputesInvoicesOrderPaymentsPayoutsSubscriptionTokensWebhook

Properties

Name Type Description
invoice_id string The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
note_to_payer string An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.
View JSON Schema on GitHub

JSON Schema

paypal-supplementary-purchase-data-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/supplementary_purchase_data",
  "title": "Capture Identifier",
  "type": "object",
  "description": "The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.",
  "properties": {
    "invoice_id": {
      "description": "The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.",
      "type": "string",
      "maxLength": 127,
      "minLength": 1,
      "pattern": "^.{1,127}$"
    },
    "note_to_payer": {
      "type": "string",
      "description": "An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.",
      "maxLength": 255,
      "minLength": 1,
      "pattern": "^.{1,255}$"
    }
  }
}

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/paypal-supplementary-purchase-data"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.