List all recurring order copies

How to fetch a collection of recurring order copies via API

To fetch a collection of recurring order copies, send a GET request to the /api/recurring_order_copies endpoint.

Request

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

Example

The following request fetches a collection of recurring order copies:

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

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

Sortable fields

The list of recurring order copies can be sorted by the following fields:

Attributes

  • status

  • started_at

  • completed_at

  • failed_at

  • errors_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • order_subscription

Filterable fields

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

Attributes

  • status

  • started_at

  • completed_at

  • failed_at

  • errors_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • source_order

  • target_order

  • events

  • order_subscription

Last updated