# Subscribe to or change your YoPrint plan

```http
POST https://secure.yoprint.com/v1/api/store/{team_slug}/setting/subscription/plan/checkout
```

- API version: v1
- Operation ID: `v1_public_setting_subscription_plan_checkout`
- Section: Team settings › [YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription.md)
- Web page: https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-checkout/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

**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_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `new_plan` (string, required): At most 191 characters.
- `operation_id` (string, required): Matches `^[A-Za-z0-9_-]{16,64}$`.
- `payment_method` (string, required): One of: `"current"`, `"replacement"`.
- `config` (array of objects, optional): At most 4 items.
  - Each item:
    - `type` (string, required): One of: `"warehouse"`, `"pricing_group"`, `"user_limit"`, `"pricing_rule"`.
    - `value` (integer, required): Minimum 0. Maximum 1000000.
- `coupon` (string, optional): At most 191 characters.
- `coupon_token` (string, optional): At most 4096 characters.
- `referral_id` (string, optional): At most 191 characters.
- `stripe_token` (string, optional): Matches `^tok_[A-Za-z0-9_]{3,187}$`.

### Example request

```bash
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"
  }'
```

## Response

`200` The billing operation reached a successful terminal state.

Fields:

- `data` (object, required)
  - `error_code` (string | null, required): Matches `^[a-z0-9_:-]{1,64}$`.
  - `kind` (string, required): One of: `"card_prepare"`, `"checkout_create"`, `"checkout_swap"`, `"payment_retry"`, `"subscription_cancel"`, `"subscription_resume"`.
  - `next_action` (string, required): One of: `"recover"`, `"refresh_billing"`, `"start_new_operation"`, `"update_card_then_retry"`, `"use_different_card"`, `"wait"`.
  - `operation_id` (string, required): Matches `^[A-Za-z0-9_-]{16,64}$`.
  - `outcome` (string | null, required): One of: `"succeeded"`, `"payment_failed"`, `"safe_failed"`.
  - `retry_class` (string | null, required): One of: `"safe"`, `"compensated"`, `"provider_retry"`, `"reconciliation_required"`.
  - `state` (string, required)
  - `terminal` (boolean, required)
- `status` (integer, optional)
- `success` (boolean, optional)

Example response:

```json
{
  "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
  }
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `402` The 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.
- `403` You 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.
- `404` Not 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.
- `409` A 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`.
- `422` Validation 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`.
- `503` Billing 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.

## Related

- [Preview a YoPrint plan change](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-preview.md): `PUT /v1/api/store/{team_slug}/setting/subscription/plan/preview`
- [Get a YoPrint billing operation](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-operation-show.md): `GET /v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}`
- [Recover a YoPrint billing operation](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-operation-recover.md): `POST /v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}/recover`