Get a link to the billing page

GET/v1/api/store/{team_slug}/setting/billing_portal

v1InternalOperation ID v1_public_setting_billing_portal_redirect

Internal

Built for YoPrint's own apps, not for integrations. It is listed so the reference is complete; don't build on it, and use the other operations in this section.

Meant to return {"url": ...}, a link to manage YoPrint billing: the billing page for the team owner, an error page for anyone else.

Today it always fails with 500, because the pages it links to no longer exist. Manage billing on the Billing page of the YoPrint web app.

Permission

Any member of the team.

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.

• dataobjectrequired
  Child fields (1)

  • urlstring (uri)required

    Not returned today; see above.

• 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.

• 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.

• 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

  Always, today. The body is {"message": "Server Error"}, without the error envelope.

  Fix

  Use the Billing page in the YoPrint web app.

Notes

• AI apps (MCP connections) can't call this operation: they get 403 agent_operation_not_available. Use a personal API key.

Example request

curl

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

Example response 200

Response

{
  "data": {
    "url": "https://example.com/billing"
  },
  "status": 200,
  "success": true
}