An order applies a plan's template to create invoice(s) for a customer, optionally at the appropriate scheduled intervals. A subscription order may also determine if the payment is collected automatically (with autopay set true).
Retrieve a list of orders.
filter | string The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format. |
sort | Array of strings The collection items sort field and order (prefix with "-" for descending sort). |
limit | integer [ 0 .. 1000 ] The collection items limit. |
offset | integer >= 0 The collection items offset. |
q | string The partial search of the text fields. |
expand | string Expand a response to get a full related object included inside of the
See the expand guide for more info. |
A list of subscriptions was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Unauthorized access, invalid credentials were used.
Access forbidden.
$subscriptions = $client->subscriptions()->search([ 'filter' => 'customerId:testCustomerId', ]);
[- {
- "orderType": "subscription-order"
}
]
Create an order. Consider using the upsert. operation to accomplish this task.
expand | string Expand a response to get a full related object included inside of the
See the expand guide for more info. |
Order resource.
orderType required | string Default: "subscription-order" Specifies the type of order, a subscription or a one-time purchase. | ||||||||||||||||||||||||||||||||||
customerId required | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||
websiteId required | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||
required | Array of objects non-empty | ||||||||||||||||||||||||||||||||||
object or null Order delivery address. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object or null Order billing address. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
couponIds | Array of strings or null A list of coupons to redeem on the customer and restrict to this subscription. Read more about coupons here. This parameter respects the following logic:
If list of applied coupons on pending order will be changed due to this param during update order, Invoice for the order will be reissued. | ||||||||||||||||||||||||||||||||||
poNumber | string or null Purchase order number, will be displayed on the issued invoices. | ||||||||||||||||||||||||||||||||||
object (Shipping) Shipping settings. | |||||||||||||||||||||||||||||||||||
notes | string Notes for the customer which will be displayed on the order invoice. | ||||||||||||||||||||||||||||||||||
object To use plan defaults do not send the | |||||||||||||||||||||||||||||||||||
isTrialOnly | boolean Default: false Whether a subscription ends after a trial period. Recurring settings are ignored if it's | ||||||||||||||||||||||||||||||||||
object or null The invoice time shift in conjunction with
| |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object or null The recurring interval to override plan settings. To use plan settings, set | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
autopay | boolean Default: true Autopay determines if a payment attempt will be automatic. | ||||||||||||||||||||||||||||||||||
startTime | string or null <date-time> Subscription start time. When the value is sent as null, it will use the current time. This value can't be in past more than one service period. | ||||||||||||||||||||||||||||||||||
renewalTime | string <date-time> Subscription renewal time. | ||||||||||||||||||||||||||||||||||
object or null (Risk metadata) Risk metadata used for 3DS and risk scoring. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map |
Order was created.
orderType required | string Default: "subscription-order" Specifies the type of order, a subscription or a one-time purchase. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerId required | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websiteId required | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects non-empty | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array (non-empty)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billingStatus | string The billing status of the most recent invoice. It may help you determine if you should change the service status such as suspending the service. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string = 3 characters ISO 4217 alphabetic currency code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
initialInvoiceId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recentInvoiceId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Order delivery address. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Order billing address. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
voidTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
poNumber | string or null Purchase order number, will be displayed on the issued invoices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Shipping) Shipping settings. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notes | string Notes for the customer which will be displayed on the order invoice. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string The status of the subscription service. A subscription starts
in the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inTrial | boolean True if the subscription is currently in a trial period. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object To use plan defaults do not send the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isTrialOnly | boolean Default: false Whether a subscription ends after a trial period. Recurring settings are ignored if it's | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null The invoice time shift in conjunction with
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null The recurring interval to override plan settings. To use plan settings, set | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autopay | boolean Default: true Autopay determines if a payment attempt will be automatic. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startTime | string or null <date-time> Subscription start time. When the value is sent as null, it will use the current time. This value can't be in past more than one service period. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewalTime | string <date-time> Subscription renewal time. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rebillNumber | integer The current period number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Subscription line items which queue until the next renewal (or interim) invoice is issued for the subscription. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Subtotal of line items in this subscription (signed value). If credits exceed debits, it will be a negative number. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewalReminderTime | string or null <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewalReminderNumber | integer or null Number of renewal reminder events triggered. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trialReminderTime | string or null <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trialReminderNumber | integer or null Number of renewal reminder events triggered. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
canceledTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
canceledBy | string Canceled by. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancelCategory | string Cancel category. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancelDescription | string <= 255 characters Cancel reason description in free form. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
revision | integer The 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (Risk metadata) Risk metadata used for 3DS and risk scoring. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of SelfLink (object) or CustomerLink (object) or InitialInvoiceLink (object) or RecentInvoiceLink (object) or WebsiteLink (object) or ApprovalUrlLink (object) non-empty The links related to resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of RecentInvoiceEmbed (object) or InitialInvoiceEmbed (object) or CustomerEmbed (object) or WebsiteEmbed (object) or LeadSourceEmbed (object) or ShippingRateEmbed (object) non-empty Any embedded objects available that are requested by the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array (non-empty) Any of: Recent Invoice object.
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "orderType": "subscription-order",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "items": [
- {
- "planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "quantity": 0,
- "plan": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}
}
], - "deliveryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO"
}, - "couponIds": [
- "string"
], - "poNumber": "PO123456",
- "shipping": {
- "calculator": "manual"
}, - "notes": "string",
- "trial": {
- "enabled": true,
- "endTime": "2019-08-24T14:15:22Z"
}, - "isTrialOnly": false,
- "invoiceTimeShift": null,
- "recurringInterval": null,
- "autopay": true,
- "startTime": null,
- "renewalTime": "2019-08-24T14:15:22Z",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "riskMetadata": null,
- "customFields": {
- "foo": "bar"
}
}
{- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "orderType": "subscription-order",
- "billingStatus": "draft",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "currency": "USD",
- "initialInvoiceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "recentInvoiceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "items": [
- {
- "planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "quantity": 0,
- "plan": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "revision": 0,
- "isModified": true,
- "isGrandfathered": true
}
], - "deliveryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "activationTime": "2019-08-24T14:15:22Z",
- "voidTime": "2019-08-24T14:15:22Z",
- "poNumber": "PO123456",
- "shipping": {
- "calculator": "manual"
}, - "notes": "string",
- "status": "pending",
- "inTrial": true,
- "trial": {
- "enabled": true,
- "endTime": "2019-08-24T14:15:22Z"
}, - "isTrialOnly": false,
- "invoiceTimeShift": null,
- "recurringInterval": null,
- "autopay": true,
- "startTime": null,
- "endTime": "2019-08-24T14:15:22Z",
- "renewalTime": "2019-08-24T14:15:22Z",
- "rebillNumber": 0,
- "lineItems": [
- {
- "type": "debit",
- "description": "string",
- "unitPriceAmount": 49.95,
- "unitPriceCurrency": "USD",
- "quantity": 1,
- "periodStartTime": "2019-08-24T14:15:22Z",
- "periodEndTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z"
}
], - "lineItemSubtotal": {
- "currency": "USD",
- "amount": 49.95
}, - "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "renewalReminderTime": "2019-08-24T14:15:22Z",
- "renewalReminderNumber": 0,
- "trialReminderTime": "2019-08-24T14:15:22Z",
- "trialReminderNumber": 0,
- "canceledTime": "2019-08-24T14:15:22Z",
- "canceledBy": "merchant",
- "cancelCategory": "billing-failure",
- "cancelDescription": "string",
- "revision": 0,
- "riskMetadata": null,
- "customFields": {
- "foo": "bar"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "recentInvoice": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "invoiceNumber": 0,
- "subscriptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "currency": "USD",
- "amount": 0,
- "amountDue": 0,
- "subtotalAmount": 0,
- "discountAmount": 0,
- "shipping": {
- "calculator": "manual"
}, - "tax": {
- "calculator": "manual",
- "amount": 0
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "deliveryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "poNumber": "PO123456",
- "notes": "string",
- "items": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "type": "debit",
- "description": "string",
- "unitPrice": 0,
- "quantity": 0,
- "price": 0,
- "productId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "discountAmount": 0,
- "periodStartTime": "2019-08-24T14:15:22Z",
- "periodEndTime": "2019-08-24T14:15:22Z",
- "periodNumber": 0,
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "tax": {
- "amount": 0,
- "description": "string",
- "rate": 0
}, - "_links": [
- {
- "rel": "self",
- "href": null
}
], - "_embedded": [
- {
- "product": null
}
]
}
], - "discounts": [
- {
- "couponId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "redemptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "amount": 0,
- "description": "string",
- "context": "items"
}
], - "autopayScheduledTime": "2019-08-24T14:15:22Z",
- "autopayRetryNumber": 0,
- "status": "draft",
- "delinquentCollectionPeriod": 0,
- "collectionPeriod": 0,
- "abandonedTime": "2019-08-24T14:15:22Z",
- "voidedTime": "2019-08-24T14:15:22Z",
- "paidTime": "2019-08-24T14:15:22Z",
- "dueTime": "2019-08-24T14:15:22Z",
- "issuedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "paymentFormUrl": "string",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "transactions": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "type": "3ds-authentication",
- "status": "completed",
- "result": "abandoned",
- "amount": 0,
- "currency": "USD",
- "purchaseAmount": 0,
- "purchaseCurrency": "USD",
- "requestAmount": 0,
- "requestCurrency": "USD",
- "parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "childTransactions": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "subscriptionIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "planIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "isRebill": true,
- "rebillNumber": 0,
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- { }
], - "emails": [
- { }
], - "dob": "1980-04-01",
- "jobTitle": "CEO",
- "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "has3ds": true,
- "3ds": {
- "server": "string",
- "version": "1.0.2",
- "enrolled": "yes",
- "authenticated": "yes",
- "liability": "protected",
- "flow": "frictionless",
- "isDowngraded": false
}, - "retryNumber": 0,
- "isRetry": true,
- "billingDescriptor": "string",
- "description": "string",
- "requestId": "string",
- "hasAmountAdjustment": true,
- "gatewayName": "A1Gateway",
- "customFields": {
- "foo": "bar"
}, - "processedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gateway": {
- "response": {
- "code": null,
- "message": null,
- "type": null,
- "originalCode": null,
- "originalMessage": null
}, - "avsResponse": {
- "code": null,
- "message": null,
- "originalCode": null,
- "originalMessage": null
}, - "cvvResponse": {
- "code": null,
- "message": null,
- "originalCode": null,
- "originalMessage": null
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "hasDcc": true,
- "dcc": {
- "base": {
- "amount": null,
- "currency": null
}, - "quote": {
- "amount": null,
- "currency": null
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": null,
- "currency": null
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- null
], - "selectedOffer": {
- "offerId": null,
- "offerType": null,
- "bumpAmount": null,
- "bumpAmountInUsd": null,
- "customFields": null
}
}, - "riskScore": 0,
- "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": null,
- "isJavaEnabled": null,
- "language": null,
- "screenWidth": null,
- "screenHeight": null,
- "timeZoneOffset": null
}, - "extraData": {
- "kountFraudSessionId": null,
- "payPalMerchantSessionId": null,
- "threatMetrixSessionId": null
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "hasFakeName": true,
- "isHighRiskCountry": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "ipVelocity": 0,
- "emailVelocity": 0,
- "billingAddressVelocity": 0,
- "score": 0
}, - "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": "response-needed",
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "reportAmount": 0,
- "reportCurrency": "USD",
- "settlementTime": "2019-08-24T14:15:22Z",
- "discrepancyTime": "2019-08-24T14:15:22Z",
- "limits": {
- "amount": 275.35,
- "currency": "USD",
- "resetTime": "2019-08-24T14:15:22Z"
}, - "_links": [
- {
- "rel": "self",
- "href": null
}
], - "_embedded": [
- {
- "parentTransaction": null
}
]
}
], - "retryInstruction": {
- "attempts": [
- {
- "scheduleInstruction": {
- "method": null
}, - "amountAdjustmentInstruction": {
- "method": null
}, - "tryBackupInstruments": false
}
], - "afterAttemptPolicies": [
- "change-subscription-renewal-time"
], - "afterRetryEndPolicies": [
- "abandon-invoice"
]
}, - "revision": 0,
- "type": "initial",
- "dueReminderTime": "2019-08-24T14:15:22Z",
- "dueReminderNumber": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "customer": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": null,
- "paymentInstrumentId": null
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": null,
- "lastName": null,
- "organization": null,
- "address": null,
- "address2": null,
- "city": null,
- "region": null,
- "country": null,
- "postalCode": null,
- "phoneNumbers": null,
- "emails": null,
- "dob": null,
- "jobTitle": null,
- "hash": null
}, - "averageValue": {
- "currency": null,
- "amount": null,
- "amountUsd": null
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": null,
- "amount": null,
- "amountUsd": null
}, - "invoiceCount": 0,
- "tags": [
- null
], - "revision": 0,
- "isEddRequired": false,
- "hasFulfilledKyc": true,
- "_links": [
- null,
- null,
- null
], - "_embedded": [
- null
]
}
}
]
}
}
]
}
Retrieve an order with specified identifier string.
expand | string Expand a response to get a full related object included inside of the
See the expand guide for more info. |
Order was retrieved successfully.
orderType required | string Default: "subscription-order" Specifies the type of order, a subscription or a one-time purchase. | |||||||||||||||||||||||||||||||
customerId required | string <= 50 characters The resource ID. Defaults to UUID v4. | |||||||||||||||||||||||||||||||
websiteId required | string <= 50 characters The resource ID. Defaults to UUID v4. | |||||||||||||||||||||||||||||||
required | Array of objects non-empty | |||||||||||||||||||||||||||||||
Array (non-empty)
| ||||||||||||||||||||||||||||||||
id | string <= 50 characters The resource ID. Defaults to UUID v4. | |||||||||||||||||||||||||||||||
billingStatus | string The billing status of the most recent invoice. It may help you determine if you should change the service status such as suspending the service. | |||||||||||||||||||||||||||||||
currency | string = 3 characters ISO 4217 alphabetic currency code. | |||||||||||||||||||||||||||||||
initialInvoiceId | string <= 50 characters The resource ID. Defaults to UUID v4. | |||||||||||||||||||||||||||||||
recentInvoiceId | string <= 50 characters The resource ID. Defaults to UUID v4. | |||||||||||||||||||||||||||||||
object or null Order delivery address. | ||||||||||||||||||||||||||||||||
|