---
title: "Get Purchase"
method: GET
path: "/api/v1/purchases/{id}"
tags: ["Purchases"]
---

# Get Purchase

`GET /api/v1/purchases/{id}`

## Path parameters

- `id` string, required

## Response `200`

Successful response

- object
  - `purchase` union, required
    - SubscriptionPurchaseClientSelectSchema
      - `id` string, required
      - `createdAt` integer, required — Epoch milliseconds.
      - `updatedAt` integer, required — Epoch milliseconds.
      - `livemode` boolean, required
      - `name` string, required
      - `status` 'open' | 'pending' | 'failed' | 'paid' | 'refunded' | 'partial_refund' | 'fraudulent', required
      - `customerId` string, required
      - `organizationId` string, required
      - `billingCycleAnchor` integer, nullable — Epoch milliseconds.
      - `priceId` string, required
      - `quantity` integer, required — A positive integer
      - `priceType` 'subscription', required
      - `trialPeriodDays` union, required
        - integer — A positive integer
        - 0
      - `pricePerBillingCycle` integer, required — A positive integer
      - `intervalUnit` 'day' | 'week' | 'month' | 'year', required
      - `intervalCount` integer, required — A positive integer
      - `firstInvoiceValue` union, required
        - integer — A positive integer
        - 0
      - `totalPurchaseValue` unknown, required
      - `bankPaymentOnly` boolean, nullable, required
      - `purchaseDate` integer, nullable — Epoch milliseconds.
      - `endDate` integer, nullable — Epoch milliseconds.
      - `proposal` string, nullable, required
      - `archived` boolean, nullable, required
      - `billingAddress` BillingAddress
        - `name` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `email` string, email, nullable
        - `address` object, required
          - `name` string, nullable
          - `line1` string, nullable
          - `line2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `postal_code` string, nullable
          - `country` string, required
        - `phone` string, nullable
      - `metadata` Metadata — JSON object
      - `pricingModelId` string, required
      - `position` number, required
    - SinglePaymentPurchaseClientSelectSchema
      - `id` string, required
      - `createdAt` integer, required — Epoch milliseconds.
      - `updatedAt` integer, required — Epoch milliseconds.
      - `livemode` boolean, required
      - `name` string, required
      - `status` 'open' | 'pending' | 'failed' | 'paid' | 'refunded' | 'partial_refund' | 'fraudulent', required
      - `customerId` string, required
      - `organizationId` string, required
      - `billingCycleAnchor` integer, nullable — Epoch milliseconds.
      - `priceId` string, required
      - `quantity` integer, required — A positive integer
      - `priceType` 'single_payment', required
      - `trialPeriodDays` unknown, required
      - `pricePerBillingCycle` unknown, required
      - `intervalUnit` unknown, required
      - `intervalCount` unknown, required
      - `firstInvoiceValue` union, required
        - integer — A positive integer
        - 0
      - `totalPurchaseValue` union, required
        - integer — A positive integer
        - 0
      - `bankPaymentOnly` boolean, nullable, required
      - `purchaseDate` integer, nullable — Epoch milliseconds.
      - `endDate` integer, nullable — Epoch milliseconds.
      - `proposal` string, nullable, required
      - `archived` boolean, nullable, required
      - `billingAddress` BillingAddress
        - `name` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `email` string, email, nullable
        - `address` object, required
          - `name` string, nullable
          - `line1` string, nullable
          - `line2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `postal_code` string, nullable
          - `country` string, required
        - `phone` string, nullable
      - `metadata` Metadata — JSON object
      - `pricingModelId` string, required
      - `position` number, required
    - UsagePurchaseClientSelectSchema
      - `id` string, required
      - `createdAt` integer, required — Epoch milliseconds.
      - `updatedAt` integer, required — Epoch milliseconds.
      - `livemode` boolean, required
      - `name` string, required
      - `status` 'open' | 'pending' | 'failed' | 'paid' | 'refunded' | 'partial_refund' | 'fraudulent', required
      - `customerId` string, required
      - `organizationId` string, required
      - `billingCycleAnchor` integer, nullable — Epoch milliseconds.
      - `priceId` string, required
      - `quantity` integer, required — A positive integer
      - `priceType` 'usage', required
      - `trialPeriodDays` unknown, required
      - `pricePerBillingCycle` unknown, required
      - `intervalUnit` unknown, required
      - `intervalCount` unknown, required
      - `firstInvoiceValue` union, required
        - integer — A positive integer
        - 0
      - `totalPurchaseValue` union, required
        - integer — A positive integer
        - 0
      - `bankPaymentOnly` boolean, nullable, required
      - `purchaseDate` integer, nullable — Epoch milliseconds.
      - `endDate` integer, nullable — Epoch milliseconds.
      - `proposal` string, nullable, required
      - `archived` boolean, nullable, required
      - `billingAddress` BillingAddress
        - `name` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `email` string, email, nullable
        - `address` object, required
          - `name` string, nullable
          - `line1` string, nullable
          - `line2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `postal_code` string, nullable
          - `country` string, required
        - `phone` string, nullable
      - `metadata` Metadata — JSON object
      - `pricingModelId` string, required
      - `position` number, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/flowglad/apis/flowglad-api-2.md) · [All operations](https://skmtc.net/flowglad/apis/flowglad-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flowglad/flowglad-api-2/versions/c838c92c3606/schema)
