get/premium/current-subscription-price

Get current subscription price

Returns the exact price the authenticated user is being billed for their active Stripe subscription, including whether they are on a grandfathered legacy rate.

get_current_subscription_price

Responses

200

Success

json

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "price_id": {
          "type": "string",
          "description": "The Stripe price ID the user is currently billed against"
        },
        "amount_minor": {
          "type": "integer",
          "format": "int53",
          "description": "The amount the user is actually charged, in the currency minor unit"
        },
        "currency": {
          "enum": [
            "USD",
            "EUR",
            "BRL",
            "INR",
            "PLN",
            "TRY"
          ],
          "type": "string",
          "x-enumNames": [
            "USD",
            "EUR",
            "BRL",
            "INR",
            "PLN",
            "TRY"
          ],
          "description": "Currency of the charged amount"
        },
        "billing_cycle": {
          "enum": [
            "monthly",
            "yearly"
          ],
          "type": "string",
          "x-enumNames": [
            "monthly",
            "yearly"
          ],
          "description": "The recurring billing cycle of the active subscription"
        },
        "is_grandfathered": {
          "type": "boolean",
          "description": "Whether the user is on a legacy price that no longer matches the current list price"
        },
        "list_amount_minor": {
          "anyOf": [
            {
              "type": "integer",
              "format": "int53"
            },
            {
              "type": "null"
            }
          ],
          "description": "The current list price for the same cycle/currency, in the currency minor unit"
        },
        "list_price_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "The current list Stripe price ID for the same cycle/currency"
        }
      },
      "required": [
        "price_id",
        "amount_minor",
        "currency",
        "billing_cycle",
        "is_grandfathered",
        "list_amount_minor",
        "list_price_id"
      ]
    },
    {
      "type": "null"
    }
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}