---
title: "Create a checkout link"
method: POST
path: "/v1/credits/checkout"
tags: ["credits"]
---

# Create a checkout link

`POST /v1/credits/checkout`

## Request

- Base URL: `https://phonebox.dev`
- URL: `https://phonebox.dev/v1/credits/checkout`
- Auth: HTTP bearer

Creates a checkout page where a person buys credits for the key's project. The credit arrives once the payment does: poll GET /v1/account until balance_usd shows it. Needs phones:control. At most 10 an hour per project.

## Request body

- object
  - `amount_usd` integer: The credit to buy, in whole US dollars.

## Response `201`

The checkout page's link, and the credit it buys.

- object
  - `url` string, uri, required: The checkout page. Give it to a person: it takes the payment and adds the credit to the key's project.
  - `amount_usd` integer, required: The credit this checkout buys, in whole US dollars, before tax and any discount.

## Other responses

- `400`: Invalid request; details.issues lists each problem as {path, message}
- `401`: Missing or invalid key
- `402`: Insufficient credits, spending limit reached, or the project is frozen
- `403`: Insufficient scope, a phone this key can't use, a browser request, or a setup request that was declined
- `404`: Not found
- `409`: Conflict: the phone's status doesn't allow this, a phone limit is reached, the Idempotency-Key was used with another body, another install is still running on the phone, a newer version of the app is on the phone, an upload that isn't ready, the project's upload storage is full, the clipboard can't be read, a recording is already running or isn't ready, the project keeps 20 recordings, a setup request that expired or already delivered its key, the project has 50 active keys
- `413`: Body too large
- `422`: The request can't be applied, such as an app that isn't in Phonebox's app library, a file that isn't an APK, an install the phone refused, or a feature this phone doesn't offer (feature_unavailable)
- `429`: Rate limited
- `500`: Unexpected server error; keep the request ID
- `502`: The phone service returned an error, or didn't confirm the action
- `503`: No capacity, the phone is briefly unavailable, Phonebox is paused, or payments aren't connected. A batch refused with this error body did nothing on the phone; a 502 or 504 without it, from a proxy or the platform, leaves the outcome unknown.
- `504`: The phone didn't respond in time

---

[API](https://skmtc.dev/phonebox/apis/phonebox-api.md) · [All operations](https://skmtc.dev/phonebox/apis/phonebox-api/llms.txt) · [OpenAPI document](https://skmtc.dev/phonebox/apis/phonebox-api/revisions/87eb2f5211b2?raw)
