Patch · Example Payload

Patch Create Order Example

Example request and response for creating a carbon offset order via the Patch API

CarbonCarbon CreditsCarbon RemovalCarbon OffsetsSustainabilityClimate TechNet ZeroESG

Patch Create Order Example is an example object payload from Patch, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

exampledescriptionrequestresponse

Example Payload

{
  "example": "Create a carbon offset order",
  "description": "Example request and response for creating a carbon offset order via the Patch API",
  "request": {
    "method": "POST",
    "url": "https://api.patch.io/v1/orders",
    "headers": {
      "Authorization": "Bearer sk_test_your_api_key",
      "Content-Type": "application/json",
      "Patch-Version": 2
    },
    "body": {
      "project_id": "pro_test_8df3e45fa",
      "amount": 1000000,
      "unit": "g",
      "currency": "USD",
      "metadata": {
        "user_id": "usr_12345",
        "order_reference": "ORD-2026-001"
      }
    }
  },
  "response": {
    "status": 200,
    "body": {
      "success": true,
      "error": null,
      "data": {
        "id": "ord_test_9ab4f23cd",
        "created_at": "2026-06-13T00:00:00Z",
        "production": false,
        "state": "placed",
        "amount": 1000000,
        "unit": "g",
        "price": 1500,
        "patch_fee": 150,
        "currency": "USD",
        "registry_url": null,
        "metadata": {
          "user_id": "usr_12345",
          "order_reference": "ORD-2026-001"
        },
        "line_items": [
          {
            "id": "oli_test_7cd2e14ab",
            "project": {
              "id": "pro_test_8df3e45fa",
              "name": "Rainforest Protection in Brazil"
            },
            "vintage_year": 2024,
            "vintage_start_year": null,
            "vintage_end_year": null,
            "amount": 1000000,
            "unit": "g",
            "price": 1500,
            "currency": "USD"
          }
        ],
        "issued_to": null
      }
    }
  }
}