APappdirect
PurchaseOrder

Retrieve a purchase order

Changed on

Retrieve a purchase order.</br></br>Rate limit: Bucket size is 20 requests, with a leak rate of 4 requests per second.<br></br>Rate limit uses leaky bucket algorithm. Usage of a leaky bucket algorithm allows client applications to make an unlimited number of requests over a large time horizon but prevents excessively large bursts over a short one.

get/billing/v1/orders/{orderId}

Request

Path parameters

orderIdnumber required

The specific order id for which information is requested

Query parameters

expandstring[]

Provide the list of comma separated resource name (possible values = "user,company,salesSupportUser") which is needed to be expanded in the response

Response

OK

_embeddedobject nullable
currencystring nullable

Currency.

endDatenumber nullable

Order end date.

endOfDiscountDatenumber nullable

Discount end date.

frequencystring nullable

Frequency.

idnumber nullable

ID.

parentSubscriptionIdnumber nullable

Parent subscription ID of an add-on subscription

serviceStartDatenumber nullable

Service start date for the order

nextBillingDatenumber nullable

Next billing date for the order

referenceCodestring nullable

Reference code

startDatenumber nullable

Order start date

statusstring nullable

Order status

totalPricenumber nullable

Total price for the order

typestring nullable

Type.

activatedboolean

True if the subscription has been activated

discountIdnumber nullable

The unique identifier for the discount applied to this order

paymentPlanIdnumber nullable

The unique identifier for the payment plan for this order

Example response

{
  "_embedded": {
    "property1": {},
    "property2": {}
  },
  "activated": true,
  "company": {
    "href": "...",
    "id": "..."
  },
  "contract": {},
  "currency": "...",
  "customAttributes": [
    {
      "attributeType": "TEXT",
      "name": "...",
      "value": "...",
      "valueKeys": [
        "...",
        "..."
      ]
    },
    {
      "attributeType": "MULTISELECT",
      "name": "...",
      "value": "...",
      "valueKeys": [
        "...",
        "..."
      ]
    }
  ],
  "discount": {
    "href": "...",
    "id": "..."
  },
  "discountId": 12345,
  "endDate": 12345,
  "endOfDiscountDate": 12345,
  "frequency": "...",
  "id": 12345,
  "links": [
    {
      "href": "...",
      "rel": "..."
    },
    {
      "href": "...",
      "rel": "..."
    }
  ],
  "nextBillingDate": 12345,
  "nextOrder": {
    "href": "...",
    "id": "..."
  },
  "oneTimeOrders": [
    {
      "_embedded": {
        "property1": {},
        "property2": {}
      },
      "company": {
        "href": "...",
        "id": "..."
      },
      "currency": "...",
      "endDate": 12345,
      "endOfDiscountDate": 12345,
      "frequency": "...",
      "id": 12345,
      "links": [
        {
          "href": "...",
          "rel": "..."
        },
        {
          "href": "...",
          "rel": "..."
        }
      ],
      "nextBillingDate": 12345,
      "paymentPlan": {
        "href": "...",
        "id": "..."
      },
      "referenceCode": "...",
      "salesSupportUser": {
        "href": "...",
        "id": "..."
      },
      "startDate": 12345,
      "status": "...",
      "totalPrice": 12345,
      "type": "...",
      "user": {
        "href": "...",
        "id": "..."
      }
    },
    {
      "_embedded": {
        "property1": {},
        "property2": {}
      },
      "company": {
        "href": "...",
        "id": "..."
      },
      "currency": "...",
      "endDate": 12345,
      "endOfDiscountDate": 12345,
      "frequency": "...",
      "id": 12345,
      "links": [
        {
          "href": "...",
          "rel": "..."
        },
        {
          "href": "...",
          "rel": "..."
        }
      ],
      "nextBillingDate": 12345,
      "paymentPlan": {
        "href": "...",
        "id": "..."
      },
      "referenceCode": "...",
      "salesSupportUser": {
        "href": "...",
        "id": "..."
      },
      "startDate": 12345,
      "status": "...",
      "totalPrice": 12345,
      "type": "...",
      "user": {
        "href": "...",
        "id": "..."
      }
    }
  ],
  "orderLines": [
    {},
    {}
  ],
  "parameters": [
    {
      "name": "...",
      "value": "..."
    },
    {
      "name": "...",
      "value": "..."
    }
  ],
  "paymentPlan": {
    "allowCustomUsage": true,
    "contract": {
      "alignWithParentCycleStartDate": true,
      "autoExtensionPricingId": 12345,
      "blockContractDowngrades": true,
      "blockContractUpgrades": true,
      "blockSwitchToShorterContract": true,
      "cancellationPeriodLimit": 12345,
      "endOfContractGracePeriod": 12345,
      "gracePeriod": {},
      "minimumServiceLength": 12345,
      "terminationFee": {}
    },
    "cost": [
      {
        "amount": {},
        "blockContractDecrease": true,
        "blockContractIncrease": true,
        "blockOriginalContractDecrease": true,
        "editionPricingItemId": 12345,
        "id": 12345,
        "increment": 12345,
        "maxUnits": 12345,
        "meteredUsage": true,
        "minUnits": 12345,
        "pricePerIncrement": true,
        "pricingStrategy": "...",
        "unit": "...",
        "unitDependency": "..."
      },
      {
        "amount": {},
        "blockContractDecrease": true,
        "blockContractIncrease": true,
        "blockOriginalContractDecrease": true,
        "editionPricingItemId": 12345,
        "id": 12345,
        "increment": 12345,
        "maxUnits": 12345,
        "meteredUsage": true,
        "minUnits": 12345,
        "pricePerIncrement": true,
        "pricingStrategy": "...",
        "unit": "...",
        "unitDependency": "..."
      }
    ],
    "discount": {
      "amount": {},
      "availableRedemptions": 12345,
      "description": "...",
      "expirationDate": 12345,
      "numOfBillingCycles": 12345,
      "percentage": 12345,
      "pricingUnit": "CALLING_FEATURE",
      "startDate": 12345
    },
    "frequency": "...",
    "href": "...",
    "id": 12345,
    "isPrimaryPrice": true,
    "keepBillDateOnUsageChange": true,
    "primaryPrice": true,
    "separatePrepaid": true,
    "tld": "...",
    "uuid": "..."
  },
  "paymentPlanId": 12345,
  "previousOrder": {
    "href": "...",
    "id": "..."
  },
  "referenceCode": "...",
  "salesSupportUser": {
    "href": "...",
    "id": "..."
  },
  "startDate": 12345,
  "status": "...",
  "totalPrice": 12345,
  "type": "...",
  "user": {
    "href": "...",
    "id": "..."
  }
}

Changes