Check a YoPrint coupon

PUT/v1/api/store/{team_slug}/setting/subscription/check_coupon

v1Operation ID v1_public_setting_subscription_check_coupon

Checks a coupon code for a plan and, when it is valid, returns its discount and a coupon_token. Send that token with the coupon to the plan preview and checkout.

It applies nothing and charges 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

application/json, required.

• couponstringrequired

  The coupon code.

• new_planstringrequired

  The plan id you want, from the plan list.

Response

200Successful response.

• dataobjectrequired
  Child fields (8)

  • amount_offinteger | null

    A fixed discount, or null for a percentage coupon. Thousandths, an older encoding: 5000 is 5.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.

  • coupon_tokenstring

    Send it as coupon_token with the same coupon to preview and checkout.

  • durationstring | null
  • duration_in_monthsinteger | null
  • idstring
  • namestring | null
  • percent_offinteger | null

    The percentage discount, or null for a fixed discount. A percentage ×1000: 25500 is 25.5%, 8250 is 8.25%. With X-Yoprint-Decimal-Format: exact-v1, a value that isn't a whole number comes back as a string.

  • trial_daysinteger
• 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 request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  The coupon is unknown or not valid for that plan and your team (invalid_coupon), or a field is missing (validation_failed).

  Fix

  Check the code.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  new_plan is not a plan id. The body is {"message": "Server Error"}, without the error envelope.

  Fix

  Use an id from the plan list.

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

Example request

curl

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

Example response 200

Response

{
  "data": {
    "amount_off": null,
    "coupon_token": "YOUR_COUPON_TOKEN",
    "duration": "once",
    "duration_in_months": null,
    "id": "WELCOME10",
    "name": "Welcome 10%",
    "percent_off": 10000,
    "trial_days": 0
  },
  "status": 200,
  "success": true
}