---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# Get product subscription details

Get product subscription details.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain",
          "description": "Your Deputy tenant subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ],
          "description": "Deputy region: au, eu, na, or deputy (AU default)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "FeatureInfo": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/FeatureInfoFeatureStatus",
            "title": "Whether the tenant has ACCESS, the feature is HIDDEN, or a PAYWALL should be shown"
          },
          "paywall": {
            "$ref": "#/components/schemas/Paywall",
            "title": "Paywall information if status is PAYWALL"
          }
        },
        "title": "Feature access information"
      },
      "FeatureInfoFeatureStatus": {
        "type": "string",
        "enum": [
          "ACCESS",
          "PAYWALL",
          "HIDDEN"
        ],
        "default": "ACCESS"
      },
      "GetProductSubscriptionResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "currentPlan": {
            "$ref": "#/components/schemas/GetProductSubscriptionResponseCurrentPlan"
          },
          "features": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/FeatureInfo"
            }
          }
        }
      },
      "GetProductSubscriptionResponseCurrentPlan": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "Paywall": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "title": "ID of the plan or add-on required (string to support add-on IDs)"
          },
          "type": {
            "$ref": "#/components/schemas/PaywallPaywallType",
            "title": "Type of paywall (PLAN or ADD-ON)"
          },
          "name": {
            "type": "string",
            "title": "Display name of the plan or add-on"
          },
          "cta": {
            "$ref": "#/components/schemas/PaywallPaywallCta",
            "title": "What should be the action of the paywall CTA"
          }
        },
        "title": "Paywall information for features that require upgrade"
      },
      "PaywallPaywallCta": {
        "type": "string",
        "enum": [
          "HIDDEN",
          "CONTACT_SALES",
          "SELF_SERVE"
        ],
        "default": "HIDDEN"
      },
      "PaywallPaywallType": {
        "type": "string",
        "enum": [
          "PLAN",
          "ADD_ON"
        ],
        "default": "PLAN"
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/v2/subscriptions/product": {
      "get": {
        "summary": "Get product subscription details",
        "operationId": "ProductSubscriptionV2Controller_GetProductSubscription",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetProductSubscriptionResponse"
                }
              }
            }
          }
        },
        "tags": [
          "Product Subscription"
        ],
        "description": "Get product subscription details."
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
```