Skip to main content Link Search Menu Expand Document (external link)

Subscription Orders


Orders list

GET “https://app.ongoingsubscriptions.com/api/v1/orders”

Description

Get a paginated list of all Subscription orders.

Request Params

  • page: number

Example Response

{
  orders: [
    {
      createdAt: "2022-07-07 21:00:47",
      isFirstOrder: true,
      isFullyPaid: 1,
      isTest: 1,
      lines: [
        {
          sku: "sage-herbs-004",
          price: { 
            total: "11.7",
            perItem: "11.7"
          }, 
          title: "Sage & Herbs",
          quantity: 1,
          variantTitle: "Sage & Herbs - Small",
          isSubscriptionLine: false
        }, {
          sku: "black-truffle-002",
          price: { 
            total: "8.1",
            perItem: "8.1",
          }, 
          title: "Black Truffle - Small / Sliced",
          quantity: 1,
          variantTitle: "Small / Sliced",
          isSubscriptionLine: true
        }
      ],
      name: "#1076",
      shopifyId: "gid://shopify/Order/4807979368684",
      subscriptionUuid: "ff4660d2-0768-11ed-a1c9-896910735dfa",
      shopifySubscriptionId: "gid://shopify/SubscriptionContract/12379874661782",
      totalPrice: "109.75",
      totalPriceCurrencyCode: "USD",
      updatedAt: "2022-07-07 21:00:54",
      uuid: "27f21226-013b-11ed-a05a-59e1b5cfbbe0"
    }, {
      createdAt: "2022-03-07 20:47:04",
      isFirstOrder: true,
      isFullyPaid: 1,
      isTest: 1,
      lines: [
        {
          sku: "sage-herbs-004",
          price: { 
            total: "14.5",
            perItem: "14.5"
          }, 
          title: "Sage & Herbs",
          quantity: 1,
          variantTitle: "Sage & Herbs - Medium",
          isSubscriptionLine: false
        }, {
          sku: "black-truffle-003",
          price: { 
            total: "8.2",
            perItem: "7.9",
          }, 
          title: "Black Truffle - Small / Whole",
          quantity: 1,
          variantTitle: "Small / Whole",
          isSubscriptionLine: true
        }
      ],
      name: "#1049",
      shopifyId: "gid://shopify/Order/4687609528556",
      subscriptionUuid: "fd53d7be-0768-11ed-82b1-5d18b393bfaa",
      shopifySubscriptionId: "gid://shopify/SubscriptionContract/8172938146129762",
      totalPrice: "7.9",
      totalPriceCurrencyCode: "USD",
      updatedAt: "2022-07-07 20:58:36",
      uuid: "2966b2e2-013b-11ed-b574-91ddeb261cdf"
    }
  ],
  pagination: {
    hasNextPage: true,
    lastPage: 25,
    page: 1,
    totalResults: 372
  },
  message: "Orders fetched successfully.",
  errors: false
}