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. |
A list of orders 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.
curl -i -X GET \ 'https://api-sandbox.rebilly.com/storefront/orders?filter=string&sort=string&limit=1000&offset=0&q=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
[- {
- "orderType": "subscription-order"
}
]
Retrieve an order with specified identifier string.
Order was retrieved successfully.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
orderType | string Default: "subscription-order" Specifies the type of order, a subscription or a one-time purchase. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
Array of objects non-empty | |||||||||||||||||||||||||||||||||
Array (non-empty)
| |||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
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) non-empty The links related to resource. | |||||||||||||||||||||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
curl -i -X GET \ 'https://api-sandbox.rebilly.com/storefront/orders/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "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
}, - "canceledTime": "2019-08-24T14:15:22Z",
- "canceledBy": "merchant",
- "cancelCategory": "billing-failure",
- "cancelDescription": "string",
- "customFields": {
- "foo": "bar"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update an order with predefined ID.
Order resource.
object or null Order delivery address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object or null Order billing address. | |||||||||||||||||||||||||||||||
|
Order was updated.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
orderType | string Default: "subscription-order" Specifies the type of order, a subscription or a one-time purchase. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
Array of objects non-empty | |||||||||||||||||||||||||||||||||
Array (non-empty)
| |||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
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) non-empty The links related to resource. | |||||||||||||||||||||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "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"
}
}
{- "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
}, - "canceledTime": "2019-08-24T14:15:22Z",
- "canceledBy": "merchant",
- "cancelCategory": "billing-failure",
- "cancelDescription": "string",
- "customFields": {
- "foo": "bar"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Cancel an order.
Order resource.
Order was canceled.
id | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
orderType | string Default: "subscription-order" Specifies the type of order, a subscription or a one-time purchase. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
Array of objects non-empty | |||||||||||||||||||||||||||||||||
Array (non-empty)
| |||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
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) non-empty The links related to resource. | |||||||||||||||||||||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Conflict.
Invalid data was sent.
{- "reason": "did-not-use",
- "description": "string"
}
{- "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
}, - "canceledTime": "2019-08-24T14:15:22Z",
- "canceledBy": "merchant",
- "cancelCategory": "billing-failure",
- "cancelDescription": "string",
- "customFields": {
- "foo": "bar"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}