Skip to main content
POST
/
cart
/
checkout
/
{projectUuid}
Checkout a project using account credit
curl --request POST \
  --url https://www.postable.com/api/v1/cart/checkout/{projectUuid} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "order_id": 123,
    "credit_charged": 123,
    "remaining_credit": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.postable.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Checkout a project and process the order using your account credit. This endpoint will:
  1. Add the project to your cart
  2. Process the order using your available account credit
  3. Return the order details including the amount charged

​
Requirements

  • The project must have at least one recipient
  • You must have sufficient account credit to cover the order total
  • Your cart must be empty or only contain this project

​
Credit Handling

If you have insufficient credit, the response will include:
  • credit_available: Your current account credit balance
  • order_total: The total amount needed to process the order

​
Example Response

{
  "data": {
    "order_id": 12345,
    "credit_charged": 25.50,
    "remaining_credit": 74.50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectUuid
string<uuid>
required

UUID of the project to checkout

Response

Checkout successful

​
data
object