Recurring Order Products

Create and manage Recurring Order Products. Recurring Order Products are added to Recurring Orders, as part of a customer's recurring order structure. You first create a recurring order using the Recurring Orders API and then use the Recurring Orders API to create and manage recurring orders, and the Recurring Order Products API to manage their recurring order products.

Recurring Order Products Get

POSThttps://api.gofarmflow.com/recurring-order-products-get

Lists all recurring order products associated with a recurring order.

Request Parameters
Field Type Required Description
recurring-order-id integer Required Recurring Order's ID
Example Request
{
    "recurring-order-id": "123"
}

Recurring Order Product Get

POSThttps://api.gofarmflow.com/recurring-order-product-get

Returns details for a single recurring order product.

Request Parameters
Field Type Required Description
id integer Required Recurring Order Product's ID
Example Request
{
    "id": "123"
}

Recurring Order Product Create

POSThttps://api.gofarmflow.com/recurring-order-product-create

Adds a recurring order product to an existing recurring order.

Request Parameters
Field Type Required Description
recurring-order-id integer Required Recurring Order's ID
product-id integer Required Product's ID
interval-id integer Required Interval ID of how often they are receiving the product
price-id integer Required Product Price's ID
quantity integer Required Quantity of product to add to the order
start-date date Required The date on which they will receive their first order
end-date date Optional The date on which they would receive their last order (optional)
price-tag decimal Optional Override your normal price tag with this price tag
cut-short integer Optional Mark this product as needing to be cut shorter than normal (accepts: 1 or 0, where 1 means YES, 0 means NO)
cut-short-buffer-pct integer Optional The percentage of which you'd like to add to your normal planting quantity to make up for it being cut short
Example Request
{
    "recurring-order-id": "123",
    "product-id": "321",
    "interval-id": "234",
    "price-id": "345",
    "quantity": "1",
    "start-date": "2026-01-01",
    "end-date": "2026-12-31",
    "price-tag": "6.00",
    "cut-short": "1",
    "cut-short-buffer-pct": "10"
}

Recurring Order Product Update

https://api.gofarmflow.com/recurring-order-product-update

Updates a recurring order product.

Request Parameters
Field Type Required Description
id integer Required Recurring Order Product's ID
recurring-order-id integer Required Recurring Order's ID
product-id integer Required Product's ID
interval-id integer Required Interval ID of how often they are receiving the product
price-id integer Required Product Price's ID
quantity integer Required Quantity of product to add to the order
start-date date Required The date on which they will receive their first order
end-date date Optional The date on which they would receive their last order (optional)
price-tag decimal Optional Override your normal price tag with this price tag
cut-short integer Optional Mark this product as needing to be cut shorter than normal (accepts: 1 or 0, where 1 means YES, 0 means NO)
cut-short-buffer-pct integer Optional The percentage of which you'd like to add to your normal planting quantity to make up for it being cut short
Example Request
{
    "id": "123",
    "recurring-order-id": "123",
    "product-id": "321",
    "interval-id": "234",
    "price-id": "345",
    "quantity": "1",
    "start-date": "2026-01-01",
    "end-date": "2026-12-31",
    "price-tag": "6.00",
    "cut-short": "1",
    "cut-short-buffer-pct": "10"
}

Recurring Order Product Delete

POSThttps://api.gofarmflow.com/recurring-order-product-delete

Deletes a recurring order product from a recurring order.

Request Parameters
Field Type Required Description
id integer Required Recurring Order Product's ID
Example Request
{
    "id": "123"
}