PayPal · Schema

Subscription Status

The subscription status details.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
status	string	The status of the subscription.
status_change_note	string	The reason or notes for the status of the subscription.
status_update_time	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/subscription_status",
  "title": "Subscription Status",
  "description": "The subscription status details.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the subscription.",
      "minLength": 1,
      "maxLength": 24,
      "pattern": "^[A-Z_]+$",
      "enum": [
        "APPROVAL_PENDING",
        "APPROVED",
        "ACTIVE",
        "SUSPENDED",
        "CANCELLED",
        "EXPIRED"
      ]
    },
    "status_change_note": {
      "type": "string",
      "description": "The reason or notes for the status of the subscription.",
      "minLength": 1,
      "maxLength": 128
    },
    "status_update_time": {
      "readOnly": true,
      "$ref": "#/components/schemas/date_time"
    }
  }
}