action britbox_get_subscription_state {
  label: "getSubscriptionState"
  description: "Returns the state of subscription for any payment platform."
  provider: britbox
  method: GET
  path: "/itv/subscriptionstate"
  encoding: json
  output: {
    type: "object"
    required: ["effective_entitlements", "failed_availability_checks", "purchased", "source"]
    properties: {
      effective_entitlements: {
        type: "array"
        description: "The array of entitlement objects."
        items: {
          type: "object"
          required: ["start", "expiry", "source", "subscriptionId", "plan"]
          properties: {
            card_type: {
              type: "string"
              format: "date-time"
              description: "Start of subscription."
            }
            expiry: {
              type: "string"
              format: "date-time"
              description: "Expiry of subscription."
            }
            plan: {
              type: "object"
              description: "Purchased plan data."
            }
            source: {
              type: "string"
              description: "Source platform of purchase."
            }
            subscriptionId: {
              type: "string"
              description: "Id of subscription."
            }
          }
          additionalProperties: false
        }
      }
      failed_availability_checks: {
        type: "array"
        description: "The results of availability checks."
        items: {
          type: "string"
        }
      }
      purchased: {
        type: "array"
        description: "The array of entitlement names."
        items: {
          type: "string"
        }
      }
      source: {
        type: "string"
        description: "The payment provider (stripe/itunes)"
      }
    }
    additionalProperties: false
  }
}