get/premium/price-ids

Get Stripe price IDs

Retrieves Stripe price IDs for premium subscriptions based on geographic location.

get_price_ids

Parameters

NameInTypeDescription
country_codequerystring
pricing_modequeryPricingModeEnum

Responses

200

Success

json
{
  "type": "object",
  "properties": {
    "monthly": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Stripe price ID for the monthly subscription"
    },
    "yearly": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Stripe price ID for the yearly subscription"
    },
    "gift_1_month": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Stripe price ID for the 1 month gift"
    },
    "gift_1_year": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Stripe price ID for the 1 year gift"
    },
    "monthly_amount_minor": {
      "anyOf": [
        {
          "type": "integer",
          "format": "int53"
        },
        {
          "type": "null"
        }
      ],
      "description": "Monthly price amount in the currency minor unit"
    },
    "yearly_amount_minor": {
      "anyOf": [
        {
          "type": "integer",
          "format": "int53"
        },
        {
          "type": "null"
        }
      ],
      "description": "Yearly price amount in the currency minor unit"
    },
    "gift_1_month_amount_minor": {
      "anyOf": [
        {
          "type": "integer",
          "format": "int53"
        },
        {
          "type": "null"
        }
      ],
      "description": "Gift 1 month price amount in the currency minor unit"
    },
    "gift_1_year_amount_minor": {
      "anyOf": [
        {
          "type": "integer",
          "format": "int53"
        },
        {
          "type": "null"
        }
      ],
      "description": "Gift 1 year price amount 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 for the prices"
    },
    "gift_currency": {
      "enum": [
        "USD",
        "EUR",
        "BRL",
        "INR",
        "PLN",
        "TRY"
      ],
      "type": "string",
      "x-enumNames": [
        "USD",
        "EUR",
        "BRL",
        "INR",
        "PLN",
        "TRY"
      ],
      "description": "Currency for gift prices"
    }
  },
  "required": [
    "currency",
    "gift_currency"
  ]
}
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"
  ]
}
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"
  ]
}