Subscribe to or change your YoPrint plan

POST/v1/api/store/{team_slug}/setting/subscription/plan/checkout

v1Operation ID v1_public_setting_subscription_plan_checkout

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

Subscribes the team to a plan, or changes its plan or paid extras. Stripe charges the card for what the change costs; preview it first. Send payment_method: current to use the card on file, or replacement with a Stripe card token (stripe_token, tok_..., made with Stripe.js in the browser). Card numbers never go to YoPrint.

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.

Business rules

Only the listed fields are accepted; anything else is refused before any charge.
stripe_token is required with replacement and not allowed with current.
Preview the change first to see what will be charged.

Side effects

Charges your card through Stripe and changes your YoPrint plan, limits and features.

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.

new_planstringrequired
- At most 191 characters
operation_idstringrequired
- Matches ^[A-Za-z0-9_-]{16,64}$
payment_methodstringrequired
- One of: "current", "replacement"
configarray of objects
- At most 4 items
Fields of each item (2)
- typestringrequired
  - One of: "warehouse", "pricing_group", "user_limit", "pricing_rule"
- valueintegerrequired
  - Minimum 0
  - Maximum 1000000
couponstring
- At most 191 characters
coupon_tokenstring
- At most 4096 characters
referral_idstring
- At most 191 characters
stripe_tokenstring
- Matches ^tok_[A-Za-z0-9_]{3,187}$

Response

200The billing 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).
402The provider declined payment and the terminal operation records the outcome.
When
The first invoice wasn't paid (outcome: payment_failed).
Fix
Follow next_action: use_different_card for a new subscription, update_card_then_retry for a plan change.
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, or billing changed meanwhile (billing_operation_conflict).
Fix
Wait, check the current operation, then try again with a new operation_id.
422Validation failed or a terminal safe failure was recorded.
When
An extra field or a token with current (invalid_payment_method), a bad config (invalid_plan_config), a missing field (validation_failed), the plan not available to you, or Stripe declined or rejected the card (error.code is Stripe's decline code, or payment_method_rejected).
Fix
Read error.code.
503Billing provider configuration or readback is temporarily unavailable.
When
Billing is temporarily unavailable (billing_provider_unavailable).
Fix
Read the operation again later; don't start a new one.

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.

PUTPreview a YoPrint plan change/v1/api/store/{team_slug}/setting/subscription/plan/preview
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 -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/subscription/plan/checkout' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "config": [],    "new_plan": "starter-monthly-v2",    "operation_id": "billing-checkout-01JZ000000000000",    "payment_method": "replacement",    "stripe_token": "tok_test_example"  }'

Example response 200

{
  "data": {
    "error_code": null,
    "kind": "checkout_create",
    "next_action": "refresh_billing",
    "operation_id": "billing-checkout-01JZ000000000000",
    "outcome": "succeeded",
    "retry_class": null,
    "state": "settled",
    "terminal": true
  }
}

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI spec Support: support@yoprint.com yoprint.com