Retrieve orders

Retrieve a list of orders.

SecurityCustomerJWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of orders retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

ID of the order.

orderType
string
Default: "subscription-order"

Specifies the type of order. An order may be a subscription or a one-time purchase.

billingStatus
string

Billing status of the most recent invoice. This value may help you to determine if you should change the service status of the service, such as suspending the service.

Enum: "draft" "unpaid" "past-due" "abandoned" "paid" "voided" "refunded" "disputed" "partially-refunded" "partially-paid"
websiteId
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

currency
string = 3 characters

Currency of the order.

initialInvoiceId
string <= 50 characters

ID of the initial invoice.

recentInvoiceId
string <= 50 characters

ID of the most recently issued invoice. The invoice might not be paid yet.

Array of objects (OrderItem) non-empty

Item details.

Array (non-empty)
required
OriginalPlan (object) or (FlexiblePlan (OneTimeSalePlan (object) or SubscriptionOrderPlan (object) or TrialOnlyPlan (object)))

Plan details.

planId
string <= 50 characters
Deprecated

ID of the plan.

quantity
integer

Number of product units in the specified plan.

revision
integer

Revision number that increments with each overriding change to this specific plan item.

isModified
boolean

Specifies if the plan information is modified for this subscription.

isGrandfathered
boolean

Specifies if the current plan revision number is greater than the plan item revision number.

object

Embedded objects that are requested by the expand query parameter.

object or null

Delivery address of the order.

firstName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\p{L},.'&]+$

Contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

object or null

Billing address of the order.

firstName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\p{L},.'&]+$

Contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

activationTime
string <date-time>

Date and time when the order is activated.

voidTime
string <date-time>

Date and time when the order is voided.

abandonTime
string or null <date-time>

Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, a pending order TTL setting is used to calculate the value.

poNumber
string or null

Purchase order number displayed on the issued invoices.

object (Shipping)

Shipping settings.

amount
required
integer

Shipping amount.

calculator
required
string

Shipping calculator.

notes
string

Notes for the customer displayed on the order invoice.

status
string

Status of the subscription service. A subscription starts in the pending status, and becomes active when the service period begins.

Enum: "pending" "active" "abandoned" "canceled" "churned" "paused" "voided" "completed" "trial-ended"
inTrial
boolean

Specifies if the subscription is currently in a trial period.

object

Trial details. To use plan defaults do not send the trial key, or send a null value.

enabled
boolean

Specifies if there is a trial for this subscription. Plans without trial prices are free trials.

endTime
string <date-time>

Time and date when the trial ends. If a trial is enabled on this subscription, a value must be provided.

isTrialOnly
boolean
Default: false

Specifies if a subscription ends after a trial period. If this value is true, recurring settings are ignored.

object or null

Shifts issue time and due time of invoices for this subscription.

This setting overrides plan settings. To use plan settings, set this value to null.

To use multiple plans in one subscription, all plans must have the same billing period, this property enables the customer to subscribe to different plans.

object (IssueTimeShiftInstruction)

Calculation instruction of the billing time.

This is used in conjunction with the service period anchor to calculate the time at which the invoice is issued. For more information, see Service period anchor, billing timing, and invoice time shift.

object (DueTimeShiftInstruction)
Default: {"duration":1,"unit":"hour"}

Calculation instruction of the invoice due time.

This is used in conjunction with the billing anchor to calculate when an invoice is due for payment. For more information, see Service period anchor, billing timing, and invoice time shift.

The sequential order of due time shift is always after the due date.

object or null

Recurring interval to override plan settings. To use plan settings, set this value to null.

To use multiple plans in one subscription, all plans must have the same same recurring period length, this property enables the customer to subscribe to different plans.

object (ServicePeriodAnchorInstruction)
Default: {"method":"immediately"}

Instruction for calculating the service period anchor.

The service period anchor is used, in conjunction with the subscription start time, to calculate when the service period starts and ends.

autopay
boolean
Default: true

Specifies if payment attempts are made automatically. If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at paymentInstrumentId, or the default payment instrument on the subscription.

startTime
string or null <date-time>

Date and time when the subscription starts. If this value is null, the current time is used. This value cannot be more than one service period in the past.

endTime
string <date-time>

Date and time when the subscription ends.

renewalTime
string <date-time>

Date and time when the subscription renews.

rebillNumber
integer

Current billing period number.

Array of objects (UpcomingInvoiceItem)

Subscription line items which queue until the next renewal (or interim) invoice is issued for the subscription.

Array
type
required
string

Type of invoice line item.

Enum: "debit" "credit"
unitPriceAmount
required
number <double>

Unit price of the line item.

unitPriceCurrency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

quantity
required
integer

Quantity of the line item.

description
string <= 1000 characters

Description of the line item.

periodStartTime
string <date-time>

Date and time when the period begins for this item.

periodEndTime
string <date-time>

Date and time when the period ends for this item.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

object

Subtotal of line items in this subscription (signed value). If credits exceed debits, this value is a negative number.

currency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
number <double>

Amount of the subtotal.

paymentInstrumentId
string or null <= 50 characters

ID of the payment instrument to use for autopay. If this value is not provided, or if the payment instrument is inactive, the customer's default payment instrument is used.

canceledTime
string <date-time>

Date and time when the subscription order is canceled.

canceledBy
string

Specifies who initiated the cancellation.

Enum: "merchant" "customer" "rebilly"
cancelCategory
string

Category of the cancellation.

Enum: "billing-failure" "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "never-started" … 2 more
cancelDescription
string <= 255 characters

Description of the cancellation reason in free form.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/storefront/orders
Request samples
Response samples
application/json
[
  • {
    }
]