The recurring order copy object
A comprehensive list of the recurring order copy resource's attributes and relationships
A recurring order copy object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/recurring_order_copies
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The recurring order copy unique identifier |
links.self |
| The recurring order copy endpoint URL |
attributes.completed_at |
| Time at which the order copy was completed. |
attributes.created_at |
| Time at which the resource was created. |
attributes.errors_count |
| Indicates the number of copy errors, if any. |
attributes.errors_log |
| Contains the order copy errors, if any. |
attributes.failed_at |
| Time at which the order copy has failed. |
attributes.metadata |
| 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. |
attributes.place_target_order |
| Indicates if the target order must be placed upon copy. |
attributes.reference |
| 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. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.reuse_wallet |
| Indicates if the payment source within the source order customer's wallet must be copied. |
attributes.started_at |
| Time at which the order copy was started. |
attributes.status |
| The order factory status. One of 'pending' (default), 'in_progress', 'failed', or 'completed'. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.events |
| The associated events. |
relationships.order_subscription |
| The associated order subscription. |
relationships.source_order |
| The source order to copy from. |
relationships.target_order |
| The copied target order. |
meta.mode |
| The resource environment (can be one of |
Last updated