get/premium/price-ids

Get Stripe price IDs

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

get_price_ids

Parameters

Name	In	Type	Description
country_code	query	string	Two-letter country code for regional pricing. Only used when the server cannot geolocate the request; otherwise the request GeoIP country wins.

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "monthly": {
      "description": "Stripe price ID for the monthly subscription",
      "type": [
        "string",
        "null"
      ]
    },
    "yearly": {
      "description": "Stripe price ID for the yearly subscription",
      "type": [
        "string",
        "null"
      ]
    },
    "gift_1_month": {
      "description": "Stripe price ID for the 1 month gift",
      "type": [
        "string",
        "null"
      ]
    },
    "gift_1_year": {
      "description": "Stripe price ID for the 1 year gift",
      "type": [
        "string",
        "null"
      ]
    },
    "monthly_amount_minor": {
      "description": "Monthly price amount in the currency minor unit",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "yearly_amount_minor": {
      "description": "Yearly price amount in the currency minor unit",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "gift_1_month_amount_minor": {
      "description": "Gift 1 month price amount in the currency minor unit",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "gift_1_year_amount_minor": {
      "description": "Gift 1 year price amount in the currency minor unit",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "currency": {
      "description": "Currency for the prices",
      "$ref": "#/components/schemas/PremiumCurrency"
    },
    "gift_currency": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PremiumCurrency"
        },
        {
          "type": "null"
        }
      ],
      "description": "Currency for gift prices, null when no gift prices are configured"
    }
  },
  "required": [
    "currency",
    "gift_currency"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}