Check a failed YoPrint payment before retrying

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

v1Operation ID v1_public_setting_subscription_current_retry_payment_preview

Reads the open renewal invoice that failed to charge: amount_remaining (in cents, as Stripe counts it: 7000 is 70.00, Stripe's own unit, unlike the thousandths or decimal pairs used elsewhere in YoPrint), currency, the card it would charge (card_brand, card_last_four), whether you can retry now (can_retry_now, retry_after), manual_retry_attempts_remaining, next_payment_attempt, and a preview_id. It changes nothing.

Show these to the person, then retry with the preview_id. If the invoice, card or Stripe state changes in between, the retry is refused with 409, so nobody is charged an amount they didn't see.

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 (8)

  • amount_remainingintegerrequired
    • Minimum 1
  • can_retry_nowbooleanrequired
  • card_brandstringrequired
  • card_last_fourstringrequired
    • Matches ^[0-9]{4}$
  • currencystringrequired
    • Matches ^[a-z]{3}$
  • next_payment_attemptstring (date-time) | nullrequired
  • preview_idstringrequired
    • At most 2048 characters
    • Matches ^v1\.[A-Za-z0-9_-]+\.[a-f0-9]{64}$
  • retry_afterstring (date-time) | 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.

• 409The canonical renewal invoice, card, or provider state changed.

  When

  The invoice, card or Stripe state changed while it was read (for example payment_retry_provider_drift).

  Fix

  Read the preview again.

• 422No exact open renewal invoice is eligible for manual retry.

  When

  No failed renewal invoice can be retried (payment_retry_not_required), or the team has no subscription (no_active_plan).

  Fix

  Nothing to pay.

• 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

• POSTRetry a failed YoPrint payment/v1/api/store/{team_slug}/setting/subscription/current/retry_payment

Example request

curl

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

Example response 200

Response

{
  "data": {
    "amount_remaining": 7000,
    "can_retry_now": true,
    "card_brand": "Visa",
    "card_last_four": "4242",
    "currency": "usd",
    "next_payment_attempt": "2026-08-10T14:00:00+00:00",
    "preview_id": "v1.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
    "retry_after": "2026-03-21T10:00:00+00:00"
  },
  "status": 200,
  "success": true
}