Get the unfinished YoPrint billing operation

GET/v1/api/store/{team_slug}/setting/subscription/operation/current

v1Operation ID v1_public_setting_subscription_operation_current

Returns the team's billing operation that hasn't finished, as operation, or operation: null when there is none. Check it before starting a change, and after an answer was lost. 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.

• dataobjectrequired
  Child fields (1)

  • operationobject | nullrequired
    Child fields (8)

    • error_codestring | nullrequired
      • Matches ^[a-z0-9_:-]{1,64}$
    • kindstringrequired
      • One of: "card_prepare", "checkout_create", "checkout_swap", "payment_retry", "subscription_cancel", "subscription_resume"
    • next_actionstringrequired
      • One of: "recover", "refresh_billing", "start_new_operation", "update_card_then_retry", "use_different_card", "wait"
    • operation_idstringrequired
      • Matches ^[A-Za-z0-9_-]{16,64}$
    • outcomestring | nullrequired
      • One of: "succeeded", "payment_failed", "safe_failed"
    • retry_classstring | nullrequired
      • One of: "safe", "compensated", "provider_retry", "reconciliation_required"
    • statestringrequired
    • terminalbooleanrequired
• 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

• GETGet a YoPrint billing operation/v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}
• POSTRecover a YoPrint billing operation/v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}/recover

Example request

curl

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

Example response 200

Response

{
  "data": {
    "operation": {
      "error_code": "provider_readback_required",
      "kind": "checkout_swap",
      "next_action": "recover",
      "operation_id": "billing-checkout-01JZ000000000000",
      "outcome": null,
      "retry_class": "reconciliation_required",
      "state": "subscription_update_dispatching",
      "terminal": false
    }
  },
  "status": 200,
  "success": true
}