List all order subscription items

How to fetch a collection of order subscription items via API

To fetch a collection of order subscription items, send a GET request to the /api/order_subscription_items endpoint.

Request

GET https://yourdomain.commercelayer.io/api/order_subscription_items

Example

Request

The following request fetches a collection of order subscription items:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/order_subscription_items/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "XAyRWNUzyN",
      "type": "order_subscription_items",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN"
      },
      "attributes": {
        "sku_code": "TSHIRTMM000000FFFFFFXLXX",
        "bundle_code": "BUNDLEMM000000FFFFFFXLXX",
        "quantity": 4,
        "unit_amount_cents": 9900,
        "unit_amount_float": 99.0,
        "formatted_unit_amount": "€99,00",
        "total_amount_cents": 18800,
        "total_amount_float": 188.0,
        "formatted_total_amount": "€188,00",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "order_subscription": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/order_subscription",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/order_subscription"
          }
        },
        "item": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/item",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/item"
          }
        },
        "sku": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/sku",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/sku"
          }
        },
        "bundle": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/bundle",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/bundle"
          }
        },
        "adjustment": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/adjustment",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/adjustment"
          }
        },
        "source_line_item": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/source_line_item",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/source_line_item"
          }
        },
        "event_stores": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/event_stores",
            "related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/event_stores"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 order_subscription_items (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14,
    "page_size": 10,
    "page_number": 1,
    "mode": "test",
    "organization_id": "xRRkjDFafe",
    "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/order_subscription_items?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/order_subscription_items?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/order_subscription_items?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of order subscription items can be sorted by the following fields:

Attributes

• quantity
• unit_amount_cents
• id
• created_at
• updated_at
• reference
• reference_origin

Relationships

• order_subscription

Filterable fields

The list of order subscription items can be filtered by the following fields:

Attributes

• quantity
• unit_amount_cents
• id
• created_at
• updated_at
• reference
• reference_origin
• metadata

Relationships

• order_subscription
• sku
• bundle
• adjustment
• source_line_item