Resume your YoPrint subscription

PATCH/v1/api/store/{team_slug}/setting/subscription/current/resume

v1Operation ID v1_public_setting_subscription_current_resume

This changes what your shop pays YoPrint. It acts on your YoPrint subscription, through Stripe, not on your customers' payments.

Undoes a scheduled cancellation, so the subscription renews and is charged as before. It works only while a cancellation is pending.

Billing operations. Every change is one billing operation, named by an operation_id you choose: 16 to 64 letters, digits, _ or -, new for each change. Keep it. The answer is the operation, as {"data": {...}} without success or status, and its HTTP status says where it stands:

• 200: done (terminal: true, outcome: succeeded). Reload the subscription.
• 202: still settling, or it needs a recovery. Read it again with GET .../setting/subscription/operation/{operation_id}, and call .../recover when next_action is recover.
• 402: the payment failed (outcome: payment_failed). Follow next_action (use_different_card or update_card_then_retry).
• 422: either refused before anything happened (the error envelope, with error.code), or the operation stopped safely (outcome: safe_failed, with error_code and next_action).
• 409: another billing operation is in progress for the team (billing_operation_conflict).
• 503: Stripe or YoPrint's billing setup can't be reached (billing_provider_unavailable).

Never start a second change because an answer was lost or slow: read or recover the same operation_id instead, so you can't be charged twice.

Permission

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

Side effects

• Removes the scheduled cancellation at Stripe; renewals are charged again.

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.

• operation_idstringrequired
  • Matches ^[A-Za-z0-9_-]{16,64}$

Response

200The subscription lifecycle operation reached a successful terminal state.

• dataobjectrequired
  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
• statusinteger
• successboolean

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.

• 409A different billing operation owns the team lifecycle or frozen state changed.

  When

  Another billing operation is in progress.

  Fix

  Wait and check the current operation.

• 422The subscription state rejected this lifecycle action or a terminal safe failure was recorded.

  When

  No cancellation is pending (subscription_not_pending_cancel), or the body has fields other than operation_id (invalid_lifecycle_context).

  Fix

  Nothing to resume.

• 503Billing provider configuration or readback is temporarily unavailable.

  When

  Billing is temporarily unavailable (billing_provider_unavailable).

  Fix

  Read the operation 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

• PATCHCancel your YoPrint subscription/v1/api/store/{team_slug}/setting/subscription/current/cancel

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/subscription/current/resume' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "operation_id": "billing-lifecycle-01JZ0000000000"  }'

Example response 200

Response

{
  "data": {
    "error_code": null,
    "kind": "subscription_resume",
    "next_action": "refresh_billing",
    "operation_id": "billing-resume-01JZ0000000000000",
    "outcome": "succeeded",
    "retry_class": null,
    "state": "settled",
    "terminal": true
  }
}