Unity Purchases API

Process virtual and real-money purchases

Operations 1

POST /v2/projects/{projectId}/environments/{environmentId}/players/{playerId}/purchases/virtual Make Virtual Purchase #

Documentation

📖
Documentation
https://docs.unity.com/ugs/en-us/manual/authentication/manual/rest-api
📖
APIReference
https://services.docs.unity.com/player-auth-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/cloud-code/manual
📖
APIReference
https://services.docs.unity.com/cloud-code-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/cloud-save/manual/reference/rest-api
📖
APIReference
https://services.docs.unity.com/cloud-save-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/economy/manual/write-configuration/rest-api
📖
APIReference
https://services.docs.unity.com/economy-admin/v2/index.html
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/leaderboards/manual/write-configuration/rest-api
📖
APIReference
https://services.docs.unity.com/leaderboards-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/remote-config/manual/write-configuration/rest-api
📖
APIReference
https://services.docs.unity.com/remote-config-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/analytics/manual/rest-api
📖
APIReference
https://services.docs.unity.com/analytics/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/lobby/manual/lobby-apis
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/matchmaker/manual/matchmaker-api
📖
APIReference
https://services.docs.unity.com/matchmaker-admin/v3/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/relay/manual/rest-api
📖
APIReference
https://services.docs.unity.com/relay-allocations/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/game-server-hosting/manual/api/rest-api
📖
APIReference
https://services.docs.unity.com/multiplay-config/v1/
📖
Documentation
https://docs.unity.com/ugs/manual/ccd/manual/ccd-rest-api
📖
APIReference
https://services.docs.unity.com/content-delivery-management/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/cloud-code/manual/triggers
📖
APIReference
https://services.docs.unity.com/triggers-admin/v1/
📖
APIReference
https://services.docs.unity.com/scheduler-admin/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/friends/manual/overview
📖
APIReference
https://services.docs.unity.com/friends/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/moderation/manual/overview
📖
APIReference
https://services.docs.unity.com/moderation/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/push-notifications/manual/overview
📖
Documentation
https://docs.unity.com/ugs/manual/devops/manual/build-automation/build-automation-api
📖
APIReference
https://build-api.cloud.unity3d.com/docs/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/devops/manual/unity-version-control
📖
APIReference
https://services.docs.unity.com/guides/unity-version-control-cm/overview/
📖
Documentation
https://docs.unity.com/ugs/manual/overview/manual/access-control
📖
APIReference
https://services.docs.unity.com/access/v1/
📖
Documentation
https://support.unity.com/hc/en-us/articles/38766626849684-How-do-I-configure-SCIM-provisioning
📖
APIReference
https://services.docs.unity.com/scim/v2/
📖
Documentation
https://unity.com/products/distributed-authority
📖
APIReference
https://services.docs.unity.com/distributed-authority/v1/
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/safe-text/manual/overview
📖
Documentation
https://docs.unity.com/ugs/en-us/manual/asset-manager/manual
📖
APIReference
https://services.docs.unity.com/assets-manager/v1/
📖
Documentation
https://docs.unity.com/ads/en-us/manual/MonetizationResourceCenter
📖
APIReference
https://services.docs.unity.com/monetize/v1/

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/unity-purchases-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

unity-purchases-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Unity Economy Purchases API
  description: The Unity Economy REST API allows you to manage in-game economies including virtual currencies, inventory items, purchases, and player balances. It provides both Admin endpoints for configuring economy resources and Player endpoints for runtime player interactions such as making purchases and checking balances.
  version: v2.0.0
  termsOfService: https://unity.com/legal/terms-of-service
  contact:
    name: Unity Support
    url: https://support.unity.com
  license:
    name: Unity Terms of Service
    url: https://unity.com/legal/terms-of-service
servers:
- url: https://economy.services.api.unity.com
  description: Unity Economy Production Server
security:
- bearerAuth: []
tags:
- name: Purchases
  description: Process virtual and real-money purchases
paths:
  /v2/projects/{projectId}/environments/{environmentId}/players/{playerId}/purchases/virtual:
    post:
      operationId: makeVirtualPurchase
      summary: Make Virtual Purchase
      description: Processes a virtual purchase using the player's in-game currency or items.
      tags:
      - Purchases
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: playerId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualPurchaseRequest'
      responses:
        '200':
          description: Purchase successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualPurchaseResult'
        '402':
          description: Insufficient funds
components:
  schemas:
    VirtualPurchaseRequest:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: The virtual purchase configuration ID
    Timestamp:
      type: object
      properties:
        date:
          type: string
          format: date-time
    InventoryItem:
      type: object
      properties:
        playersItemId:
          type: string
        inventoryItemId:
          type: string
        quantity:
          type: integer
        instanceData:
          type: object
        writeLock:
          type: string
        created:
          $ref: '#/components/schemas/Timestamp'
        modified:
          $ref: '#/components/schemas/Timestamp'
    CurrencyBalance:
      type: object
      properties:
        currencyId:
          type: string
        balance:
          type: integer
        writeLock:
          type: string
        created:
          $ref: '#/components/schemas/Timestamp'
        modified:
          $ref: '#/components/schemas/Timestamp'
    VirtualPurchaseResult:
      type: object
      properties:
        id:
          type: string
        purchased:
          type: object
          properties:
            currencies:
              type: array
              items:
                $ref: '#/components/schemas/CurrencyBalance'
            inventory:
              type: array
              items:
                $ref: '#/components/schemas/InventoryItem'
        costs:
          type: object
          properties:
            currencies:
              type: array
              items:
                $ref: '#/components/schemas/CurrencyBalance'
            inventory:
              type: array
              items:
                $ref: '#/components/schemas/InventoryItem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Unity Economy Documentation
  url: https://docs.unity.com/ugs/en-us/manual/economy/manual/write-configuration/rest-api