Create runtime Checkout Session
POST
/v1/servers/{serverId}/runtime/payments/checkout-sessionsCreate a Stripe Checkout Session through the payments resource bound to this runtime.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| serverId | path | string | Yes | Resource ID |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| successUrl | string | Yes | — |
| cancelUrl | string | Yes | — |
| clientReferenceId | string | No | — |
| conversionId | string | No | — |
| lineItems | object[] | Yes | — |
| lineItems[].name | string | No | Human-readable name. |
| lineItems[].unitAmount | integer | No | Amount in the smallest currency unit. |
| lineItems[].currency | string | No | — |
| lineItems[].quantity | integer | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Checkout Session createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| serverId | string | No | Resource ID. |
| paymentsServerId | string | No | — |
| checkoutSession | object | No | — |
| checkoutSession.id | string | No | Unique identifier. |
| checkoutSession.object | string | No | — |
| checkoutSession.url | string | No | — |
| checkoutSession.status | string | No | Current lifecycle status. |
| url | string | No | — |