PayPal · Schema

Product Element

The details for a product in the collection response.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
id string The ID of the product.
name string The product name.
description string The product description.
create_time object The date and time when the product was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
links array An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).
View JSON Schema on GitHub

JSON Schema

paypal-product-collection-element-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/product_collection_element",
  "title": "Product Element",
  "description": "The details for a product in the collection response.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the product.",
      "minLength": 6,
      "maxLength": 50,
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The product name.",
      "minLength": 1,
      "maxLength": 127
    },
    "description": {
      "type": "string",
      "description": "The product description.",
      "minLength": 1,
      "maxLength": 256
    },
    "create_time": {
      "description": "The date and time when the product was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
      "readOnly": true,
      "$ref": "#/components/schemas/date_time"
    },
    "links": {
      "type": "array",
      "description": "An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/link_description",
        "readOnly": true
      }
    }
  }
}