Update an item schedule

patch

https://example.com/api/latest/data/item-schedules/{id}

Path Params

uuid

required

Body Params

uuid

ID used to reference an existing schedule in bulk requests.

billingPeriod

string

enum

Allowed:

productId

uuid

Product id for a specific version of the product. Must have the same root as the parent Item.

startIndex

int32

Start at regular payment index. Used for relative dates to the start date.

endIndex

int32

Inclusive end at regular payment index. Used for relative dates to the start date.

price

object

Total list amount for this level. null for usage.

listPrice

object

Total list amount for this level. null for usage.

quantity

number

Quantity

discount

boolean

Indicates whether the price should be considered a discount. May not be true if price is higher than listPrice.

levels

array of objects

Level price and discount info. Required for tiered products.

levels

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK