List all order subscriptions

How to fetch a collection of order subscriptions via API

To fetch a collection of order subscriptions, send a GET request to the /api/order_subscriptions endpoint.

Request

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

Example

Request

The following request fetches a collection of order subscriptions:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/order_subscriptions/' \
  -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": "xYZkjABcde",
      "type": "order_subscriptions",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde"
      },
      "attributes": {
        "number": "1234",
        "status": "draft",
        "frequency": "monthly",
        "activate_by_source_order": true,
        "place_target_order": true,
        "renewal_alert_period": 1,
        "customer_email": "[e-mail]",
        "starts_at": "2018-01-01T12:00:00.000Z",
        "expires_at": "2018-01-02T12:00:00.000Z",
        "last_run_at": "2018-01-01T12:00:00.000Z",
        "next_run_at": "2018-01-01T12:00:00.000Z",
        "occurrencies": 2,
        "errors_count": 3,
        "succeeded_on_last_run": true,
        "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": {
        "market": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/market",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/market"
          }
        },
        "subscription_model": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/subscription_model",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/subscription_model"
          }
        },
        "source_order": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/source_order",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/source_order"
          }
        },
        "customer": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/customer",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/customer"
          }
        },
        "customer_payment_source": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/customer_payment_source",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/customer_payment_source"
          }
        },
        "order_subscription_items": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/order_subscription_items",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/order_subscription_items"
          }
        },
        "order_factories": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/order_factories",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/order_factories"
          }
        },
        "recurring_order_copies": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/recurring_order_copies",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/recurring_order_copies"
          }
        },
        "orders": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/orders",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/orders"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/events"
          }
        },
        "tags": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/tags",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/tags"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/versions"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 order_subscriptions (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/order_subscriptions?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/order_subscriptions?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/order_subscriptions?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 subscriptions can be sorted by the following fields:

Attributes

• number

• status

• frequency

• starts_at

• expires_at

• last_run_at

• next_run_at

• occurrencies

• errors_count

• succeeded_on_last_run

• id

• created_at

• updated_at

• reference

• reference_origin

Relationships

• market

• subscription_model

• customer

• customer_payment_source

Filterable fields

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

Attributes

• number

• status

• frequency

• customer_email

• starts_at

• expires_at

• last_run_at

• next_run_at

• occurrencies

• errors_count

• succeeded_on_last_run

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• market

• subscription_model

• source_order

• customer

• customer_payment_source

• events

• tags