item_requestBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/assembly-payments/main/json-schema/assembly-payments-item-request-body-schema.json",
  "title": "item_requestBody",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/assembly-payments-api-openapi.yml#/components/schemas/item_requestBody",
  "type": "object",
  "required": [
    "id",
    "name",
    "amount",
    "payment_type",
    "buyer_id",
    "seller_id"
  ],
  "properties": {
    "id": {
      "description": "Unique ID that can be generated by the platform. Cannot contain '.' or '/' characters. Contact Assembly support if you want item IDs to be generated automatically.",
      "type": "string",
      "default": "7190770-1-2908"
    },
    "name": {
      "description": "A name for the item",
      "type": "string",
      "default": "Item 7190770-1-2908"
    },
    "amount": {
      "description": "The cost in cents",
      "type": "integer",
      "default": "102"
    },
    "currency": {
      "description": "[ISO 4217 alpha-3](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. This is an optional field and if not provided, the item will be created with the default currency of the marketplace.",
      "type": "string"
    },
    "payment_type": {
      "description": "Payment type: 2. Express",
      "type": "integer",
      "default": "2"
    },
    "buyer_id": {
      "description": "Marketplace / Pltform buyer ID",
      "type": "string",
      "default": "buyer-719013950014"
    },
    "seller_id": {
      "description": "Marketplace / Platform Seller ID",
      "type": "string",
      "default": "seller-71718579"
    },
    "fee_ids": {
      "description": "A comma separated list of fee IDs to apply",
      "type": "string"
    },
    "description": {
      "description": "A description of the item",
      "type": "string"
    },
    "buyer_url": {
      "description": "Link for the buyer CTA (Call To Action)",
      "type": "string"
    },
    "seller_url": {
      "description": "Link for the seller CTA (Call To Action)",
      "type": "string"
    },
    "tax_invoice": {
      "description": "Toggle to generate tax invoice once Item is complete",
      "type": "boolean"
    },
    "custom_descriptor": {
      "description": "When `custom_descriptors` are enabled, this is the information to appear on credit card and direct debit statements.",
      "type": "string"
    }
  }
}