APappdirect
PaymentPlan

Read payment plan

Changed on

Read payment plan information

get/marketplace/v1/paymentPlans/{paymentPlanId}

Request

Path parameters

paymentPlanIdnumber required

Payment plan id

Response

Payment plan information returned.

hrefstring

URL to payment plan details

Example response

{
  "cost": [
    {
      "amount": {
        "AUD": 12345,
        "BRL": 12345,
        "CAD": 12345,
        "CHF": 12345,
        "CNY": 12345,
        "DKK": 12345,
        "EUR": 12345,
        "GBP": 12345,
        "GTQ": 12345,
        "INR": 12345,
        "JPY": 12345,
        "KRW": 12345,
        "MXN": 12345,
        "MYR": 12345,
        "NOK": 12345,
        "NZD": 12345,
        "PHP": 12345,
        "SAR": 12345,
        "SEK": 12345,
        "SGD": 12345,
        "USD": 12345,
        "ZAR": 12345
      },
      "blockContractDecrease": true,
      "blockContractIncrease": true,
      "blockOriginalContractDecrease": true,
      "editionPricingItemId": 12345,
      "id": 12345,
      "increment": 12345,
      "maxUnits": 12345,
      "meteredUsage": true,
      "minUnits": 12345,
      "pricePerIncrement": true,
      "pricingStrategy": "...",
      "unit": "...",
      "unitDependency": "..."
    },
    {
      "amount": {
        "AUD": 12345,
        "BRL": 12345,
        "CAD": 12345,
        "CHF": 12345,
        "CNY": 12345,
        "DKK": 12345,
        "EUR": 12345,
        "GBP": 12345,
        "GTQ": 12345,
        "INR": 12345,
        "JPY": 12345,
        "KRW": 12345,
        "MXN": 12345,
        "MYR": 12345,
        "NOK": 12345,
        "NZD": 12345,
        "PHP": 12345,
        "SAR": 12345,
        "SEK": 12345,
        "SGD": 12345,
        "USD": 12345,
        "ZAR": 12345
      },
      "blockContractDecrease": true,
      "blockContractIncrease": true,
      "blockOriginalContractDecrease": true,
      "editionPricingItemId": 12345,
      "id": 12345,
      "increment": 12345,
      "maxUnits": 12345,
      "meteredUsage": true,
      "minUnits": 12345,
      "pricePerIncrement": true,
      "pricingStrategy": "...",
      "unit": "...",
      "unitDependency": "..."
    }
  ],
  "href": "...",
  "links": [
    {
      "href": "...",
      "rel": "..."
    },
    {
      "href": "...",
      "rel": "..."
    }
  ]
}

Changes