Retrieve an order subscription

GET https://{{subdomain}}.commercelayer.io/api/order_subscriptions/{{order_subscription_id}}

HEADERS

RESPONSES

status: OK

{"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":"john@example.com","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"}}}