---
title: "Read payment plan"
method: GET
path: "/marketplace/v1/paymentPlans/{paymentPlanId}"
tags: ["PaymentPlan"]
---

# Read payment plan

`GET /marketplace/v1/paymentPlans/{paymentPlanId}`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/marketplace/v1/paymentPlans/{paymentPlanId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/marketplace/v1/paymentPlans/:paymentPlanId/get.ts> (a function with typed inputs; its response is checked against the schema)

Read payment plan information

## Path parameters

- `paymentPlanId` number, required

## Response `200`

Payment plan information returned.

- ResourceOfPaymentPlanWS, nullable: Resource links
  - `links` Link[]: Resource links
    - `href` string
    - `rel` string
  - `cost` PlanCostWS[]: List of plan costs
    - `amount` PriceWS, nullable: Price information in different currencies
      - `AUD` number
      - `BRL` number
      - `CAD` number
      - `CHF` number
      - `CNY` number
      - `DKK` number
      - `EUR` number
      - `GBP` number
      - `GTQ` number
      - `INR` number
      - `JPY` number
      - `KRW` number
      - `MXN` number
      - `MYR` number
      - `NOK` number
      - `NZD` number
      - `PHP` number
      - `SAR` number
      - `SEK` number
      - `SGD` number
      - `USD` number
      - `ZAR` number
    - `blockContractDecrease` boolean: Block contract decrease
    - `blockContractIncrease` boolean: Block contract increase
    - `blockOriginalContractDecrease` boolean: Block original contract decrease
    - `editionPricingItemId` number
    - `id` number: ID
    - `increment` number: Increment amount
    - `maxUnits` number: Max unit to buy
    - `meteredUsage` boolean: Is metered usage
    - `minUnits` number: Minimum unit to buy
    - `pricePerIncrement` boolean: Price per increment
    - `pricingStrategy` string: Pricing strategy
    - `unit` string, nullable: Unit
    - `unitDependency` string: Unit dependency
  - `href` string: URL to payment plan details

## Other responses

- `404`: Payment plan not found.

## Changes

- **2026-11-06** `1fc240f06971`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/marketplace/v1/paymentPlans/:paymentPlanId/get.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)