List schedules

GET 
/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.

Operator	Attribute	Description
eq	external_ref	Equals. 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

200

Success. A list of schedules is returned.

application/json

Schema

Schema

data Schedule[]
Array [
id UUID (string)
The unique identifier.
type SubscriptionScheduleType (string)required
Possible values: [subscription_schedule]
attributes ScheduleAttributesrequired
external_ref ExternalRef (string)
Possible values: <= 2048 characters
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
name string
Possible values: >= 3 characters and <= 1024 characters
The name of the schedule.
specification stringrequired
Possible values: <= 1024 characters
A cron-style specification of when the jobs should be created. See Schedules.
location stringrequired
Possible values: <= 1024 characters
The location of the time zone that the schedule operates in. Subscriptions runs on Coordinated Universal Time (UTC) time and conforms to RFC 3339.
job ScheduleJobrequired
job_type JobType (string)required
Possible values: [billing-run, tax-run, payment-run, import]
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.
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
meta ScheduleMetarequired
scheduled_for date-time
owner stringrequired
The owner of a resource, either store or organization.
timestamps Timestampsrequired
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
]
links object
anyOf
title

Example (from schema)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "subscription_schedule",
      "attributes": {
        "external_ref": "abc123",
        "name": "Daily billing run.",
        "specification": "30 0 * * *",
        "location": "Europe/London",
        "job": {
          "job_type": "billing-run"
        },
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "meta": {
        "scheduled_for": "2017-07-21T17:32:28Z",
        "owner": "store",
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z"
        }
      }
    }
  ],
  "links": {}
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Loading...