---
updatedAt: 2026-05-22T18:18:28.000Z
agentTools:
  projectIndex: https://docs.kyshi.co/llms.txt
---

# Retrieve a subscription

Returns one subscription by ID or code, including its current status and retry state.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v1/subscriptions/{id}": {
      "get": {
        "description": "Returns one subscription by ID or code, including its current status and retry state.",
        "operationId": "getSubscription",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Identifier of the resource.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResponseDto"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/PublicSubscriptionDto"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid request parameter.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "401": {
            "description": "No valid API key provided.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "403": {
            "description": "The API key lacks permission for this request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found. A 404 on an object you just created is usually a test/live mode mismatch.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "422": {
            "description": "Business rule failure, such as an unsupported currency or insufficient balance.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on Kyshi’s end.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "summary": "Retrieve a subscription",
        "tags": [
          "Subscriptions"
        ],
        "x-readme": {
          "code-samples": [
            {
              "language": "typescript",
              "name": "Kyshi SDK",
              "code": "import { Kyshi } from '@kyshi/mor-sdk';\n\nconst kyshi = new Kyshi({ secretKey: process.env.KYSHI_SECRET_KEY! });\n\nconst result = await kyshi.subscriptions.retrieve(\"9f8fca44-c60b-4a31-878b-6fd4bcaad53c\");",
              "install": "npm install @kyshi/mor-sdk"
            },
            {
              "language": "curl",
              "code": "curl --request GET \\\n  --url 'https://api.kyshi.co/v1/subscriptions/9f8fca44-c60b-4a31-878b-6fd4bcaad53c' \\\n  --header 'x-api-key: YOUR_API_KEY' \\\n  --header 'Content-Type: application/json'"
            },
            {
              "language": "javascript",
              "name": "Node.js (fetch)",
              "code": "const response = await fetch('https://api.kyshi.co/v1/subscriptions/9f8fca44-c60b-4a31-878b-6fd4bcaad53c', {\n  method: 'GET',\n  headers: {\n    'x-api-key': process.env.KYSHI_API_KEY,\n    'Content-Type': 'application/json',\n  },\n});\n\nconst result = await response.json();"
            }
          ]
        }
      }
    }
  },
  "info": {
    "title": "Kyshi MoR Public API",
    "description": "Public API reference for Kyshi integrators.",
    "version": "1.0",
    "contact": {}
  },
  "tags": [
    {
      "name": "Subscriptions",
      "description": "Bill a customer on a repeating schedule, with automatic retries and dunning."
    }
  ],
  "servers": [
    {
      "url": "https://api.kyshi.co",
      "description": "Production and Sandbox"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    },
    "schemas": {
      "SuccessResponseDto": {
        "type": "object",
        "properties": {
          "status": {
            "type": "boolean",
            "example": true,
            "description": "`true` on success."
          },
          "message": {
            "type": "string",
            "example": "Success"
          },
          "code": {
            "type": "number",
            "example": 200,
            "description": "Mirrors the HTTP status code."
          },
          "data": {
            "type": "object",
            "example": {},
            "description": "The endpoint-specific payload."
          }
        },
        "required": [
          "status",
          "message",
          "code",
          "data"
        ]
      },
      "ErrorResponseDto": {
        "type": "object",
        "properties": {
          "status": {
            "type": "boolean",
            "example": false,
            "description": "`false` on failure."
          },
          "message": {
            "type": "string",
            "example": "Unsupported Merchant Currency",
            "description": "Human-readable summary. Log it, but do not branch on it: the wording can change."
          },
          "code": {
            "type": "number",
            "example": 422,
            "description": "Mirrors the HTTP status code."
          },
          "data": {
            "type": "object",
            "example": {},
            "description": "Always empty on failure."
          }
        },
        "required": [
          "status",
          "message",
          "code",
          "data"
        ]
      },
      "PublicPlanDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "plan_7f2f9170"
          },
          "name": {
            "type": "string",
            "example": "Monthly Pro"
          },
          "amount": {
            "type": "number",
            "example": 5000
          },
          "currency": {
            "type": "string",
            "example": "USD"
          },
          "interval": {
            "type": "string",
            "example": "monthly"
          },
          "isActive": {
            "type": "boolean",
            "example": true
          },
          "createdAt": {
            "type": "string",
            "example": "2026-09-22T06:11:46.331Z"
          }
        },
        "required": [
          "id",
          "name",
          "amount",
          "currency"
        ]
      },
      "PublicSubscriptionDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "sub_7f2f9170"
          },
          "status": {
            "type": "string",
            "example": "ACTIVE"
          },
          "plan": {
            "$ref": "#/components/schemas/PublicPlanDto"
          },
          "customer": {
            "type": "object",
            "additionalProperties": true,
            "example": {}
          },
          "nextChargeAt": {
            "type": "string",
            "example": "2026-10-22T00:00:00.000Z"
          },
          "createdAt": {
            "type": "string",
            "example": "2026-09-22T06:11:46.331Z"
          }
        },
        "required": [
          "id",
          "status"
        ]
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
```