Order subscriptions allow repeating a given source order according to a specified frequency: smaller is
daily, larger is
Order subscriptions by default activates from a
placed source order, which is considered the subscription's first run. In such case the subscription is marked as
active and inherits the
starts_at time from source order
placed_at time, scheduling next runs on it.
In case you want full control over the order subscription, you can specify the
activate_by_source_order option as
false at creation time. In this case you are not limited to placed source orders (source order status isn't checked), but must define manually the
starts_at time (
expires_at time is optional).
Also remember to use the
_activate attribute to activate the subscription, otherwise it will miss the next run.
To suspend or cancel an order subscription you can use the
Order subscriptions rely on order copies to create periodic orders.
A tentative to place the copied order is done at the end of the process. You can set the
place_target_order option as
false at creation time if you prefer to place created orders manually.
Currently, order subscriptions have no retry policy: in case, for any reason, the order copy fails, the
errors_count counter is incremented, but the subscription is kept
Is possible to check the
succeeded_on_last_run attribute to inspect subscription last run state: in case its value is
false, you can inspect the last associated
order_copy to fix any missing/bad data and manually place the copied order.
You can attach
webhooks on order subscriptions and order copies events, to act promptly in case something unexpected happens.
An order subscription object is returned as part of the response body of each successful list, retrieve, create or update API call.
The order subscription unique identifier
The order subscription endpoint URL
Unique identifier for the subscription (numeric)
The subscription status. One of 'draft' (default), 'inactive', 'active', or 'cancelled'.
The frequency of the subscription. One of 'daily', 'weekly', 'monthly', or 'yearly'.
Indicates if the subscription will be actvated considering the placed source order as its first run, default to true.
The email address of the customer, if any, associated to the source order.
The activation date/time of this subscription.
The expiration date/time of this subscription (must be after starts_at).
The date/time of the subscription next run.
The number of times this subscription has run.
Indicates the number of subscription errors, if any.
Indicates if the subscription has succeeded on its last run.
The subscription options used to create the order copy (check order_copies for more information). For subscriptions the
Send this attribute if you want to mark this subscription as active.
Send this attribute if you want to mark this subscription as inactive.
Send this attribute if you want to mark this subscription as cancelled.
Time at which the resource was created.
Time at which the resource was last updated.
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
Any identifier of the third party system that defines the reference code
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
The associated market, inherited from the source order if not specified.
The subscription source order.
The subscription customer.
The associated order copies.
The associated copied orders.
The resource environment (can be one of