Orders (legacy)

Use these operations to manage customer orders.

This is the legacy order model. If you are new to Rebilly, use these order operations. Organizations that use the current order model cannot create legacy orders. For these organizations, the operations that create a legacy order return a validation error.

For information on the legacy order model, and how to upgrade to the current order model, see Legacy orders model.

An order is a customer's request to purchase items. It can contain subscription and one-time sale items. When an order contains one or more subscription items, it is a subscription order.

An order generates an invoice. A subscription order generates an invoice for each service period. For more information, see Orders.

Operations

Retrieve orders

Request

Retrieves a list of orders.
Security
SecretApiKey or JWT or ApplicationJWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limit the number of subscriptions to return. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total. When expand includes initialInvoice or recentInvoice, cap values greater than 100 at 100.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
qstring
Use this field to perform a partial search of text fields.
expandstring

Expand a response to receive a full related object in the _embedded path.

To expand multiple objects, use a comma-separated list. Example: expand=recentInvoice,initialInvoice.

Available arguments are:

  • customer
  • leadSource
  • website
  • shippingRate
  • initialInvoice
  • recentInvoice
  • upcomingInvoice
  • paymentInstrument

For more information, see Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/subscriptions?filter=string&sort=string&limit=0&offset=0&q=string&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of orders retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only
ID of the order.
Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
orderTypestringrequired

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

Note: The order type cannot be changed after creation.

Value:"subscription-order"
Discriminator
customerIdstring, <= 50 characters(CustomerId)required
ID of the customer resource.
Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
renewalReminderTimestring or null, (date-time)read-only
Date and time when the renewal reminder event triggers.
renewalReminderNumberinteger or nullread-only
Number of triggered renewal reminder events.
abandonReminderTimestring or null, (date-time)read-only
Date and time when the abandon order reminder event triggers.
abandonReminderNumberinteger or nullread-only
Number of abandon order reminder events that are triggered.
organizationIdstring, <= 50 characters(OrganizationId)read-only

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
statusstringread-only

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"
inTrialbooleanread-only
Specifies if the subscription is currently in a trial period.
trialobject

Details of the trial. To use plan defaults, omit the trial key or set this value to null.

isTrialOnlyboolean

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

Default:false
trialConversionTimestring or null, (date-time)read-only
Date and time when the subscription had a trial conversion. Trial conversion occurs when the first successful payment is made after a trial period.
invoiceTimeShiftobject or null(InvoiceTimeShift)
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.
autopayboolean

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.

Default:true
startTimestring 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.

Default:null
Example:null
churnTimestring or null, (date-time)read-only
Date and time when the subscription is deactivated.
renewalTimestring or null, (date-time)
Date and time when the subscription renews.
currentPeriodStartstring, (date-time)read-only
Date and time of the current service period start.
currentPeriodEndstring, (date-time)read-only
Date and time of the current service period end.
rebillNumberinteger or nullread-only
Current billing period number.
mrrnumber, (double)read-only
Monthly recurring revenue of the order.
Example:49.95
paymentInstrumentIdstring 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.
Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"
billingStatusstringread-only
Billing status of the most recent invoice. This value is used to determine whether to 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"
websiteIdstring, <= 50 charactersrequired

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

Note: The ID of the website cannot be changed after creation.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
currencystring, = 3 characters(CurrencyCode)read-only
Currency of the order.
Example:"USD"
initialInvoiceIdstring or null, <= 50 charactersread-only
ID of the initial invoice.
Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
recentInvoiceIdstring or null, <= 50 charactersread-only

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

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
itemsArray of objects, non-empty(SubscriptionOrOneTimeSaleItem)required
Details of items in the order.
deliveryAddressContactObject (object) or null
One of:
Contact's information.
billingAddressContactObject (object) or null
One of:
Contact's information.
activationTimestring or null, (date-time)read-only
Date and time when the order is activated.
voidTimestring or null, (date-time)read-only
Date and time when the order is voided.
abandonTimestring 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.

delinquencyPeriodstring or null

Length of time, in ISO-8601 durations format, which is added to the due time of the order when setting the delinquency time for all related invoices. When the delinquency time of an invoice is reached, the order is automatically canceled.

  • If the delinquencyPeriod value is null, the order does not change state and remains active. You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
  • If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the delinquencyTime parameter using the upsert an invoice API operation.

If this value is not passed during order creation, an order delinquency period setting is used to calculate the value.

Default:null
Example:"P7D"
poNumberstring or null
Purchase order number displayed on the issued invoices.
Example:"PO123456"
sandboxRetentionobject or null(SandboxRetention)

Sandbox recurring order retention. In the sandbox environment, a recurring order is canceled 90 days after it is created or on the start date of the policy, whichever is later. The order is not canceled if it is retained or if the organization is excluded from the policy. This property is returned in the sandbox environment only, for recurring orders. In the live environment, if the request includes this property with a value, a validation error is returned. A null value in a request does not update the property.

shippingobject(Shipping)
notesstring
Notes for the customer displayed on the order invoice.
canceledTimestring or null, (date-time)read-only
Date and time when a subscription is canceled.
canceledBystring or nullread-only
Specifies who initiated the cancellation.
Enum:"merchant""customer""rebilly"null
cancelCategorystring or nullread-only

Category of the cancellation.

The sandbox-retention value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.

Enum:"billing-failure""delinquency""did-not-use""did-not-want""missing-features""bugs-or-problems""do-not-remember""risk-warning""contract-expired""too-expensive"
cancelDescriptionstring or null, <= 255 charactersread-only
Description of the cancellation reason in free form.
revisionintegerread-only
Number of times the order data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
riskMetadataRisk metadata (object) or null
One of:
Risk metadata used for 3D Secure and risk scoring.
billingPortalTokenstring or nullread-only
Customer JWT to access a billing portal. This field is presented only if a billing portal exists. This is an experimental field and can be changed or removed in the future.
customFieldsobject(ResourceCustomFields)

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.

Default:{}
Example:
{
  "foo": "bar"
}
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
_linksArray of objectsread-only
Related links.
_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

lineItemsArray of objectsread-onlydeprecated
Subscription line items which queue until the next renewal, or interim, invoice is issued for the subscription.
lineItemSubtotalobjectread-onlydeprecated

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

]
Response
[
  {
    "id": "sub_01HRF27SATGE4Z6PBJE6PD8328",
    "orderType": "subscription-order",
    "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
    "renewalReminderTime": "2019-08-24T14:15:22Z",
    "renewalReminderNumber": 0,
    "abandonReminderTime": "2019-08-24T14:15:22Z",
    "abandonReminderNumber": 0,
    "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
    "status": "pending",
    "inTrial": true,
    "trial": { … },
    "isTrialOnly": false,
    "trialConversionTime": "2019-08-24T14:15:22Z",
    "invoiceTimeShift": { … },
    "autopay": true,
    "startTime": null,
    "churnTime": "2019-08-24T14:15:22Z",
    "renewalTime": "2019-08-24T14:15:22Z",
    "currentPeriodStart": "2019-08-24T14:15:22Z",
    "currentPeriodEnd": "2019-08-24T14:15:22Z",
    "rebillNumber": 0,
    "lineItems": [ … ],
    "lineItemSubtotal": { … },
    "mrr": 49.95,
    "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
    "billingStatus": "draft",
    "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "currency": "USD",
    "initialInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
    "recentInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
    "items": [ … ],
    "deliveryAddress": { … },
    "billingAddress": { … },
    "activationTime": "2019-08-24T14:15:22Z",
    "voidTime": "2019-08-24T14:15:22Z",
    "abandonTime": "2019-08-24T14:15:22Z",
    "delinquencyPeriod": "P7D",
    "poNumber": "PO123456",
    "sandboxRetention": { … },
    "shipping": { … },
    "notes": "string",
    "canceledTime": "2019-08-24T14:15:22Z",
    "canceledBy": "merchant",
    "cancelCategory": "billing-failure",
    "cancelDescription": "string",
    "revision": 0,
    "riskMetadata": { … },
    "billingPortalToken": "string",
    "customFields": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ],
    "_embedded": { … }
  }
]