PayPal · Schema

subscriptions.patch-422

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
details array
View JSON Schema on GitHub

JSON Schema

paypal-subscriptionspatch-422-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/subscriptions.patch-422",
  "title": "subscriptions.patch-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": "SUBSCRIPTION_STATUS_INVALID",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "SUBSCRIPTION_STATUS_INVALID"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Invalid subscription status for patch action; subscription status should be either active or suspended."
                ]
              }
            }
          },
          {
            "title": "CARD_SUBSCRIPTIONS_NOT_ENABLED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "CARD_SUBSCRIPTIONS_NOT_ENABLED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The account is not setup to be able to process subscriptions funded by card payments. Please contact PayPal customer support."
                ]
              }
            }
          },
          {
            "title": "3DS_CARDS_NOT_SUPPORTED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "3DS_CARDS_NOT_SUPPORTED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Cards that require 3DS authentication not supported."
                ]
              }
            }
          },
          {
            "title": "BILLING_CYCLE_EXECUTION_COMPLETED",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "BILLING_CYCLE_EXECUTION_COMPLETED"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "Update cannot be performed on a billing cycle that has completed execution."
                ]
              }
            }
          },
          {
            "title": "AMOUNT_GREATER_THAN_OUTSTANDING_BALANCE",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "AMOUNT_GREATER_THAN_OUTSTANDING_BALANCE"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The new outstanding balance cannot be greater than the current outstanding balance."
                ]
              }
            }
          },
          {
            "title": "INVALID_BILLING_TOTAL_CYCLES",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_BILLING_TOTAL_CYCLES"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The total cycles cannot be less than the number of billing cycles completed."
                ]
              }
            }
          },
          {
            "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_START_TIME",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "INVALID_START_TIME"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The start time cannot be updated for a subscription that has been activated."
                ]
              }
            }
          },
          {
            "title": "CURRENCY_MISMATCH",
            "properties": {
              "issue": {
                "type": "string",
                "enum": [
                  "CURRENCY_MISMATCH"
                ]
              },
              "description": {
                "type": "string",
                "enum": [
                  "The currency code is different from the subscription's currency code."
                ]
              }
            }
          }
        ]
      }
    }
  }
}