PayPal · Schema

422

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
details array
View JSON Schema on GitHub

JSON Schema

paypal-422-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/422",
  "title": "422",
  "properties": {
    "details": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "title": "USER_ACCOUNT_CLOSED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "USER_ACCOUNT_CLOSED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "User account locked or closed."
                ]
              }
            }
          },
          {
            "title": "CURRENCY_MISMATCH",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "CURRENCY_MISMATCH"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "All currency codes in the request should be of similar value."
                ]
              }
            }
          },
          {
            "title": "MULTIPLE_FREE_TRIAL_BILLING_CYCLES_NOT_SUPPORTED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "MULTIPLE_FREE_TRIAL_BILLING_CYCLES_NOT_SUPPORTED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Only one free trial billing cycle is allowed."
                ]
              }
            }
          },
          {
            "title": "MORE_THAN_TWO_TRIAL_BILLING_CYCLE_NOT_SUPPORTED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "MORE_THAN_TWO_TRIAL_BILLING_CYCLE_NOT_SUPPORTED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Only two trial billing cycles are allowed."
                ]
              }
            }
          },
          {
            "title": "MISSING_REGULAR_BILLING_CYCLE",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "MISSING_REGULAR_BILLING_CYCLE"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Plan should have at least one regular billing cycle."
                ]
              }
            }
          },
          {
            "title": "MULTIPLE_REGULAR_BILLING_CYCLES_NOT_SUPPORTED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "MULTIPLE_REGULAR_BILLING_CYCLES_NOT_SUPPORTED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Only one regular billing cycle is allowed."
                ]
              }
            }
          },
          {
            "title": "INVALID_BILLING_CYCLE_SEQUENCE",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_BILLING_CYCLE_SEQUENCE"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Billing cycle sequence should start with `1` and be consecutive."
                ]
              }
            }
          },
          {
            "title": "INVALID_BILLING_CYCLE_SEQUENCE",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_BILLING_CYCLE_SEQUENCE"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Trial Billing cycle should precede regular billing cycle."
                ]
              }
            }
          },
          {
            "title": "INVALID_TRIAL_BILLING_TOTAL_CYCLES",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_TRIAL_BILLING_TOTAL_CYCLES"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Total cycles for trial billing must be greater than '0'."
                ]
              }
            }
          },
          {
            "title": "INVALID_PRICING_TIER_AMOUNT",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_PRICING_TIER_AMOUNT"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Free tiers are not supported."
                ]
              }
            }
          },
          {
            "title": "MISSING_PRICING_SCHEME_TIERS",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "MISSING_PRICING_SCHEME_TIERS"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Tier(s) are missing for some quantities."
                ]
              }
            }
          },
          {
            "title": "OVERLAPPING_PRICING_SCHEME_TIERS",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "OVERLAPPING_PRICING_SCHEME_TIERS"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The specified quantity overlaps with multiple pricing tiers."
                ]
              }
            }
          },
          {
            "title": "INVALID_PRICING_MODEL",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_PRICING_MODEL"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The specified pricing model is not supported for trial billing cycle."
                ]
              }
            }
          },
          {
            "title": "FIXED_PRICE_NOT_SUPPORTED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "FIXED_PRICE_NOT_SUPPORTED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Fixed price is not supported for tiered pricing schemes."
                ]
              }
            }
          },
          {
            "title": "INVALID_PRICING_TIER_QUANTITY",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_PRICING_TIER_QUANTITY"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Tier starting quantity must be less than ending quantity."
                ]
              }
            }
          },
          {
            "title": "INVALID_QUANTITY_SUPPORTED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_QUANTITY_SUPPORTED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Quantity is always supported for volume and tiered plans."
                ]
              }
            }
          },
          {
            "title": "CURRENCY_NOT_SUPPORTED_FOR_RECEIVER",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "CURRENCY_NOT_SUPPORTED_FOR_RECEIVER"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "This currency cannot be accepted for this recipient\u2019s account."
                ]
              }
            }
          },
          {
            "title": "INVALID_METADATA_CUSTOM_NOTE",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_METADATA_CUSTOM_NOTE"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Merchant custom note cannot exceed 255 characters."
                ]
              }
            }
          },
          {
            "title": "INVALID_METADATA_INVOICE_ID",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_METADATA_INVOICE_ID"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Invoice id cannot exceed 127 characters."
                ]
              }
            }
          }
        ]
      }
    }
  }
}