Preview a YoPrint plan change

PUT/v1/api/store/{team_slug}/setting/subscription/plan/preview

v1Operation ID v1_public_setting_subscription_plan_preview

Shows what a plan change would cost before you make it: amount_due now and the ending_balance, as Stripe calculates them, in thousandths (69000 is 69.00; see Money and quantities). It changes nothing.

It works only for a team that already has a subscription; otherwise you get 422 preview_not_available. Send only new_plan, config, coupon and coupon_token; any other field is refused.

Permission

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

Business rules

• config lists the paid extras, each {type, value} with type warehouse, pricing_group, user_limit or pricing_rule, once each, within the plan's limits.
• A coupon needs the coupon_token from "Check a YoPrint coupon".

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• new_planstringrequired
  • At most 191 characters
• configarray of objects
  • At most 4 items
  Fields of each item (2)

  • typestringrequired
    • One of: "warehouse", "pricing_group", "user_limit", "pricing_rule"
  • valueintegerrequired
    • Minimum 0
    • Maximum 1000000
• couponstring
  • At most 191 characters
• coupon_tokenstring
  • At most 4096 characters

Response

200Successful response.

• dataobjectrequired
  Child fields (2)

  • amount_dueintegerrequired
    • Minimum 0
  • ending_balanceinteger | nullrequired
• 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.

• 422The requested plan preview is invalid or unavailable for this team.

  When

  An extra field (invalid_plan_preview_context), a bad config (invalid_plan_config), an unknown or unavailable plan (invalid_plan), a bad coupon (invalid_coupon), no subscription to change (preview_not_available), or a missing field (validation_failed).

  Fix

  Read error.code.

• 503Billing provider configuration or readback is temporarily unavailable.

  When

  Billing is temporarily unavailable (billing_provider_unavailable).

  Fix

  Try again later.

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

• POSTSubscribe to or change your YoPrint plan/v1/api/store/{team_slug}/setting/subscription/plan/checkout
• PUTCheck a YoPrint coupon/v1/api/store/{team_slug}/setting/subscription/check_coupon

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/subscription/plan/preview' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "config": [],    "new_plan": "starter-monthly-v2"  }'

Example response 200

Response

{
  "data": {
    "amount_due": 69000,
    "ending_balance": 0
  },
  "status": 200,
  "success": true
}