List YoPrint plans you can choose

GET/v1/api/store/{team_slug}/setting/subscription/plan

v1Operation ID v1_public_setting_subscription_plan_index

Returns the YoPrint plans your team can subscribe to, including any private plan YoPrint gave your team: each with its id, name, billing_cycle, price, features, the extras you can configure (config_option), and the trial_plan_id to use during a trial.

Reading it changes nothing.

Permission

The team owner, or a member with the Manage Billing permission. Manage Settings alone is not enough.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (11)

  • idstringrequired

    Send it as new_plan to preview and checkout.

  • namestringrequired
  • typestringrequired

    paid for a plan you subscribe to.

  • billing_cyclestring
    • One of: "monthly", "annually"
  • config_optionarray of objects | null
    Fields of each item (7)

    • idstring

      The config[].type to send to preview and checkout.

      • One of: "warehouse", "pricing_group", "user_limit", "pricing_rule"
    • includedinteger

      How many the plan includes.

    • labelstring
    • maxinteger
    • mininteger

      The smallest config[].value: what the plan includes.

    • priceobject

      The price of each extra one; {"type": "none"} when the plan sells none.

    • typestring
  • configurableboolean

    Whether extras can be added (config_option).

  • display_featuresarray | object

    What the plan includes, as the pricing page lists it: rows of {text, tooltip, has_tooltip, is_bold, is_new}.

  • freeboolean
  • is_archivedboolean

    An old plan, still listed when YoPrint gave it to your team privately.

  • priceinteger

    The plan's price per billing cycle before extras, coupons and tax. Thousandths, an older encoding: 39000 is 39.00. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • trial_plan_idstring | null

    Send it as plan_id to choose this plan for a trial.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  You are not the owner and your role lacks Manage Billing. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the owner's key, or that of a member with Manage Billing.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• Part of your YoPrint subscription: what your shop pays YoPrint, not your customers' payments.
• AI apps (MCP connections) can't call this operation: they get 403 agent_operation_not_available. Use a personal API key.

Related

• PUTPreview a YoPrint plan change/v1/api/store/{team_slug}/setting/subscription/plan/preview
• POSTSubscribe to or change your YoPrint plan/v1/api/store/{team_slug}/setting/subscription/plan/checkout
• POSTChoose the plan for your free trial/v1/api/store/{team_slug}/setting/subscription/plan/select_trial

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/subscription/plan' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "billing_cycle": "monthly",
      "config_option": [
        {
          "id": "user_limit",
          "included": 3,
          "label": "Users",
          "max": 100,
          "min": 3,
          "price": {
            "type": "none"
          },
          "type": "number"
        }
      ],
      "configurable": true,
      "display_features": [
        {
          "has_tooltip": false,
          "is_bold": true,
          "is_new": false,
          "text": "3 Users Included",
          "tooltip": ""
        }
      ],
      "free": false,
      "id": "starter-monthly-v2",
      "is_archived": false,
      "name": "Starter",
      "price": 39000,
      "trial_plan_id": "starter-trial",
      "type": "paid"
    }
  ],
  "status": 200,
  "success": true
}