Skip to main content

Update a schedule

PUT 

/subscriptions/schedules/:schedule_uuid

Update a schedule

Request

Path Parameters

    schedule_uuid UUIDrequired

    The unique identifier of the schedule.

Body

    data ScheduleUpdaterequired
    id UUID (string)required

    The unique identifier.

    type SubscriptionScheduleType (string)required

    Possible values: [subscription_schedule]

    attributes ScheduleUpdateAttributesrequired
    external_ref ExternalRefUpdate (string)nullable

    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 stringnullable

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

    The name of the schedule.

    specification string

    Possible values: <= 1024 characters

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

    location string

    Possible values: <= 1024 characters

    The location of the time zone that the schedule operates in.

    job ScheduleJob
    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.

Responses

Success. The schedule details are returned.

Schema
    data Schedule
    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.

Loading...