Skip to main content

List schedules

GET 

https://euwest.api.elasticpath.com/v2/subscriptions/schedules

Retrieves a list of all schedules.

Filtering

This endpoint supports filtering. For the general syntax, see Filtering.

The following attributes and operators are supported.

OperatorAttributeDescription
eqexternal_refEquals. Checks if the values of two operands are equal. If they are, the condition is true.

Request

Query Parameters

    page[offset] int64

    Possible values: <= 10000

    The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

    page[limit] int64

    The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

    filter string

Responses

Success. A list of schedules is returned.

Schema
    data Schedule[]
  • Array [
  • idUUID (string)

    The unique identifier.

    Example: 11111111-2222-3333-4444-555555555555
    typeSubscriptionScheduleType (string)required

    Possible values: [subscription_schedule]

    Example: subscription_schedule
    attributes ScheduleResponseAttributes
    external_refExternalRef (string)

    A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

    Possible values: <= 2048 characters

    Example: abc123
    namestring

    The name of the schedule.

    Possible values: >= 3 characters and <= 1024 characters

    Example: Daily billing run.
    specificationstringrequired

    A cron-style specification of when the jobs should be created. See Schedules.

    Possible values: <= 1024 characters

    Example: 30 0 * * *
    locationstringrequired

    The location of the time zone that the schedule operates in. Subscriptions runs on Coordinated Universal Time (UTC) time and conforms to RFC 3339.

    Possible values: <= 1024 characters

    Example: Europe/London
    job ScheduleJobrequired
    job_typeJobType (string)required

    The type of job. One of the following:

    • billing_run - a billing run job.
    • payment_run - a payment run job.
    • tax_run - a tax run job.

    Possible values: [billing-run, tax-run, payment-run, import]

    Example: billing-run
    updated_atstringrequired

    The date and time a resource was updated.

    Example: 2017-01-10T11:41:19.244842Z
    created_atstringrequired

    The date and time a resource was created.

    Example: 2017-01-10T11:41:19.244842Z
    meta ScheduleMetarequired
    scheduled_fordate-time
    Example: 2017-07-21T17:32:28Z
    ownerstringrequired

    The owner of a resource, either store or organization.

    Example: store
    timestamps Timestampsrequired
    updated_atstringrequired

    The date and time a resource was updated.

    Example: 2017-01-10T11:41:19.244842Z
    created_atstringrequired

    The date and time a resource was created.

    Example: 2017-01-10T11:41:19.244842Z
  • ]
  • links object
    property name* Link
    anyOf
    stringnullable
    Example: http://example.com/articles/1/comments

Authorization: http

name: BearerTokentype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/v2/subscriptions/schedules");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com/v2
Auth
Parameters
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.