🔒 Requires read-orders or write-orders and read-customers or write-customers access scope.

The order's object

{
    "id": 5985083031826,
    "name": "1414",
    "email": "cheetos@recurpay.com",
    "phone": "+12025550151",
    "subscriber": {
        "id": "6964807663890",
        "email": "cheetos@recurpay.com",
        "first_name": "cheetos",
        "last_name": "c",
        "phone": "+12025550151",
        "total_spent": 1200,
        "note": "Hello merchant!",
        "addresses": [{
            "first_name": "Cheetos",
            "last_name": "C",
            "email": "cheetos@recurpay.com",
            "phone": "+12025550151",
            "address1": "17718 Sherman Way",
            "address2": null,
            "company": null,
            "city": "Los Angeles",
            "zip": "91335",
            "province": "California",
            "country": "United States"
        }],
        "default_address": {
            "first_name": "Cheetos",
            "last_name": "C",
            "email": "cheetos@recurpay.com",
            "phone": "+12025550151",
            "address1": "17718 Sherman Way",
            "address2": null,
            "company": null,
            "city": "Los Angeles",
            "zip": "91335",
            "province": "California",
            "country": "United States"
        },
        "channel": "ecommerce",
        "meta": [],
        "created_at": "2023-06-05 17:26:16",
        "updated_at": "2024-07-04 14:23:24"
    },
    "cart_token": null,
    "checkout_token": null,
    "line_items": [{
        "id": 15172331045138,
        "price": "2500.00",
        "product_id": 8441674629394,
        "quantity": 1,
        "requires_shipping": true,
        "sku": null,
        "title": "Amorearth Desi Gir Cow A2 Cultured Ghee",
        "variant_id": 45703992639762,
        "variant_title": "250 / Standard",
        "vendor": "Developer-Recurpay",
        "name": "Amorearth Desi Gir Cow A2 Cultured Ghee - 250 / Standard",
        "price_set": {
            "shop_money": {
                "amount": "2500.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "2500.00",
                "currency_code": "USD"
            }
        },
        "properties": [{
            "name": "_recurpay_line_id",
            "value": "41"
        }],
        "taxable": true,
        "tax_lines": [{
                "channel_liable": false,
                "price": "150.00",
                "price_set": {
                    "shop_money": {
                        "amount": "150.00",
                        "currency_code": "USD"
                    },
                    "presentment_money": {
                        "amount": "150.00",
                        "currency_code": "USD"
                    }
                },
                "rate": 0.05,
                "title": "California State Tax"
            },
            {
                "channel_liable": false,
                "price": "6.25",
                "price_set": {
                    "shop_money": {
                        "amount": "6.25",
                        "currency_code": "USD"
                    },
                    "presentment_money": {
                        "amount": "6.25",
                        "currency_code": "USD"
                    }
                },
                "rate": 0.00,
                "title": "Los Angeles County Tax"
            },
            {
                "channel_liable": false,
                "price": "56.25",
                "price_set": {
                    "shop_money": {
                        "amount": "56.25",
                        "currency_code": "USD"
                    },
                    "presentment_money": {
                        "amount": "56.25",
                        "currency_code": "USD"
                    }
                },
                "rate": 0.02,
                "title": "Los Angeles County District Tax Sp"
            },
            {
                "channel_liable": false,
                "price": "25.00",
                "price_set": {
                    "shop_money": {
                        "amount": "25.00",
                        "currency_code": "USD"
                    },
                    "presentment_money": {
                        "amount": "25.00",
                        "currency_code": "USD"
                    }
                },
                "rate": 0.01,
                "title": "Los Angeles Co Local Tax Sl"
            }
        ],
        "total_discount": "0.00",
        "total_discount_set": {
            "shop_money": {
                "amount": "0.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "0.00",
                "currency_code": "USD"
            }
        },
        "discount_allocations": []
    }],
    "note": "hiiii",
    "note_attributes": [{
            "name": "_recurpay_plan_discount",
            "value": "0"
        },
        {
            "name": "_recurpay_bot_discount",
            "value": "0"
        },
        {
            "name": "_delivery_frequency",
            "value": "1 month"
        },
        {
            "name": "_billing_frequency",
            "value": "1 month"
        },
        {
            "name": "_renewal_order",
            "value": "This is 6th order of subscription 41"
        }
    ],
    "tags": "",
    "shipping_address": {
        "first_name": "Cheetos",
        "last_name": "C",
        "email": "cheetos@recurpay.com",
        "phone": "+12025550151",
        "address1": "17718 Sherman Way",
        "address2": null,
        "company": null,
        "city": "Los Angeles",
        "zip": "91335",
        "province": "California",
        "country": "United States"
    },
    "billing_address": {
        "first_name": "Cheetos",
        "last_name": "C",
        "email": "cheetos@recurpay.com",
        "phone": "+12025550151",
        "address1": "17718 Sherman Way",
        "address2": null,
        "company": null,
        "city": "Los Angeles",
        "zip": "91335",
        "province": "California",
        "country": "United States"
    },
    "shipping_lines": [{
        "price": "5.00",
        "price_set": {
            "shop_money": {
                "amount": "5.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "5.00",
                "currency_code": "USD"
            }
        },
        "title": "Standard Shipping"
    }],
    "currency": "USD",
    "subtotal_price": 2500,
    "subtotal_price_set": {
        "shop_money": {
            "amount": 2500,
            "currency_code": "USD"
        },
        "presentment_money": {
            "amount": 2500,
            "currency_code": "USD"
        }
    },
    "total_discounts": 0,
    "total_discounts_set": {
        "shop_money": {
            "amount": 0,
            "currency_code": "USD"
        },
        "presentment_money": {
            "amount": 0,
            "currency_code": "USD"
        }
    },
    "total_tax": 237.5,
    "total_tax_set": {
        "shop_money": {
            "amount": 237.5,
            "currency_code": "USD"
        },
        "presentment_money": {
            "amount": 237.5,
            "currency_code": "USD"
        }
    },
    "total_shipping": 5,
    "total_shipping_set": {
        "shop_money": {
            "amount": 5,
            "currency_code": "USD"
        },
        "presentment_money": {
            "amount": 5,
            "currency_code": "USD"
        }
    },
    "total_price": 2742.5,
    "total_price_set": {
        "shop_money": {
            "amount": 2742.5,
            "currency_code": "USD"
        },
        "presentment_money": {
            "amount": 2742.5,
            "currency_code": "USD"
        }
    },
    "gateway": "shopify_payments",
    "financial_status": "authorized",
    "fulfillment_status": "created",
    "created_at": "2024-07-03 15:32:11",
    "updated_at": "2024-07-03 15:32:22"
}

The order resource

Attribute	Type	Description
id	integer`readonly`	An unsigned 64-bit integer that's used as a unique identifier for the order. Each id is unique across the Recurpay system. No two orders will have the same id, even if they're from different stores.
name	string	The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings on ecommerce. This is different from the id property, which is the ID of the order used by the API.
email	string	The email address of the subscriber. Which is used to send notifications of any activity on their subscription.
phone	string	The subscriber's phone number for receiving SMS notifications.
subscriber	array	Information about the subscriber. For more information about the subscriber object, see the Subscriber resource.
cart_token	string	A unique value when referencing the cart that's associated with the order.
checkout_token	string	A unique value when referencing the checkout that's associated with the order.
line_items	array	A list of line item objects, each containing information about an item in the order. view
note	string	An optional note that a shop owner can attach to the order.
note_attributes	array	Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry contains a hash with name and value keys. view
tags	string	Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
shipping_address	array	The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping. view
billing_address	array	The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. view
shipping_lines	array	An array of objects, each of which details a shipping method used. view
currency	string	The three-letter code (ISO 4217 format) for the shop currency.
subtotal_price	string	The price of the order in the shop currency after discounts but before shipping, and taxes.
subtotal_price_set	object	The subtotal of the order in shop and presentment currencies after discounts but before shipping, and taxes. view
total_discounts	string	The total discounts applied to the price of the order in the shop currency.
total_discounts_set	object	The total discounts applied to the price of the order in shop and presentment currencies. view
total_tax	string	The sum of all the taxes applied to the order in the shop currency. Must be positive.
total_tax_set	object	The total tax applied to the order in shop and presentment currencies. view
total_shipping	string	The total shipping applied to the order in the shop currency.
total_shipping_set	object	The total shipping applied to the order in shop and presentment currencies. view
total_price	string	The sum of all line item prices, discounts, shipping, and taxes in the shop currency.
total_price_set	object	The total price of the order in shop and presentment currencies. view
gateway	string	The payment gateway used.
financial_status	string	The status of payments associated with the order. Can only be set when the order is created. Valid values: pending: The payments are pending. Payment might fail in this state. Check again to confirm whether the payments have been paid successfully. authorized: The payments have been authorized. partially_paid: The order has been partially paid. paid: The payments have been paid. partially_refunded: The payments have been partially refunded. refunded: The payments have been refunded. voided: The payments have been voided.
fulfillment_status	string	The order's status in terms of fulfilled line items. Valid values: fulfilled: Every line item in the order has been fulfilled. null: None of the line items in the order have been fulfilled. partial: At least one line item in the order has been fulfilled. restocked: Every line item in the order has been restocked and the order canceled.
created_at	string `readonly`	The autogenerated date and time (ISO 8601 format) when the order was created. The value for this property cannot be changed.
updated_at	string `readonly`	The date and time (ISO 8601 format) when the order was last modified.

Line Items

Attribute	Type	Description
id	integer`readonly`	The ID of the line item.
product_id	integer	The ID of the product that the line item belongs to. Can be null if the original product associated with the order is deleted at a later date.
variant_id	integer	The ID of the product variant.
sku	string	The item's SKU (stock keeping unit).
name	string	The name of the product variant.
title	string	The title of the product.
variant_title	string	The title of the product variant.
quantity	integer	The number of items that were purchased.
vendor	string	The name of the item's supplier.
requires_shipping	boolean	Whether the item requires shipping.
price	string	The price of the item before discounts have been applied in the shop currency.
price_set	array	The price of the line item in shop and presentment currencies. view
properties	array	An array of custom information for the item that has been added to the cart. Often used to provide product customization options. view
taxable	boolean	Whether the item was taxable.
tax_lines	array	A list of tax line objects, each of which details a tax applied to the item. view
total_discount	string	The total amount of the discount allocated to the line item in the shop currency.
total_discount_set	array	The total amount allocated to the line item in the presentment currency. view
discount_allocations	array	An ordered list of amounts allocated by discount applications. Each discount allocation is associated with a particular discount application. view

Properties

Attribute	Type	Description
name	string	Name of the attribute, for ex: name is Preferred Flavor
value	string	Value of the attribute, for ex: value is Vanilla

Tax Lines

Attribute	Type	Description
price	string	The amount added to the order for this tax in the shop currency after discounts are applied.
rate	string	The rate of tax to be applied.
title	string	The name of the tax.

Discount Allocations

Attribute	Type	Description
amount	string	The amount added to the order for this tax in the shop currency after discounts are applied.
discount_application_index	integer	The index of the associated discount application in the order's discount_applications list.
amount_set	array	The discount amount allocated to the line item in shop and presentment currencies. view

Note Attributes

Attribute	Type	Description
name	string	Name of the attribute, for ex: name is Preferred Time Of Delivery
value	string	Value of the attribute, for ex: value is 10 AM - 5 PM

Shipping Lines

Attribute	Type	Description
price	string	The price of this shipping method in the shop currency. Can't be negative.
price_set	array	The price of the shipping method in shop and presentment currencies. view
title	string	The title of the shipping method.

Address

Attribute	Type	Description
first_name	string	The subscriber's first name.
last_name	string	The subscriber's last name.
email	string	The email address of the subscriber.
phone	string	The subscriber's phone number at this address.
address1	string	The first line of the subscriber's mailing address.
address2	string	An additional field for the subscriber's mailing address.
company	string	The subscriber's company.
city	string	The subscriber's city, town, or village.
zip	string	The subscriber's postal code, also known as zip, postcode, Eircode, etc.
province	string	The subscriber's region name. Typically a province, a state, or a prefecture.
country	string	The subscriber's country.

Price Set

Attribute	Type	Description
shop_money	array	The main currency of your ecommerce store. view
presentment_money	array	The presentment money that was used to display prices to the customer. view

Price Set Value

Attribute	Type	Description
amount	string	The value in which customers have completed their purchases.
currency_code	string	The three-letter code (ISO 4217 format) for the currency.