Upsert an order

Solutions
Our Solutions
Solve all things payments with a single integration
Solutions overview
Products
Payments
Harness the perfect payment orchestration platform and sell anything, anywhere
KYC
Verify IDs and monitor identities with powerful built-in AML tools
Billing
Price, deliver and manage subscription billing & invoicing
Features
Risk & Compliance
Reduce PCI compliance scope and fight fraud on a single ultra-secure platform
Reporting & Automation
Leverage data and intelligence to unlock more revenue
Pricing
Docs
About
Company
Blog About us Customer stories Careers
Technology
Gateway integrations Payment methods

Solution Overview

Solutions

Reporting & Automation

About

Developer docs

Rebilly API

Orders

Upsert an order

Creates or updates (upserts) an order with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT

Request

path Parameters

required

string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

query Parameters

expand

string

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 Expand to include embedded objects.

Request Body schema: application/json
required

Order resource.

orderType required	string Specifies the type of order. An order may be a subscription or a one-time purchase. subscription-order
customerId required	string (CustomerId) <= 50 characters ID of the customer resource.
	object Trial details. To use plan defaults do not send the `trial` key, or send a `null` value.
isTrialOnly	boolean Default: false Specifies if a subscription ends after a trial period. If this value is `true`, recurring settings are ignored.
	(InvoiceTimeShift (object or null)) or null 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.
	object or null Recurring interval to override plan settings. To use plan settings, set this value to `null`. To use multiple plans in one subscription, all plans must have the same recurring period length.
autopay	boolean Default: true 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.
startTime	string 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.
renewalTime	string or null <date-time> Date and time when the subscription renews.
paymentInstrumentId	string 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.
websiteId required	string <= 50 characters ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
required	Array of objects (SubscriptionOrOneTimeSaleItem) non-empty Details of items in the order.
	ContactObject (object) or null Delivery address of the order.
	ContactObject (object) or null Billing address of the order.
abandonTime	string 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.
delinquencyPeriod	string or null Default: 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 provided value is `null`, the order does not change state.
couponIds	Array of strings or null List of coupons to redeem on the customer and restrict to this order. For more information, see Coupons. This parameter uses the following logic: If this parameter is not supplied, applied coupons are not changed. If an empty array is supplied, all applied coupon redemptions are canceled. If a list of coupons is supplied, unapplied coupons in the list are applied. Coupons that have already been applied do not change state. Applied coupons that are not supplied in list are canceled. If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued.
poNumber	string or null Purchase order number displayed on the issued invoices.
	object (Shipping) Shipping settings.
notes	string Notes for the customer displayed on the order invoice.
riskMetadata	object or null Risk metadata. If this value is `null`, this field uses risk metadata that is captured when creating the payment token.
customFields	object (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.

put

/subscriptions/{id}

Request samples
Payload
PHP-SDK-2.0
JavaScript
PHP
application/json
subscription-order
{
"orderType": "subscription-order",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"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",
"paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
"websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
"currency": "USD",
"items": [
{
"planId": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X",
"quantity": 0,
"quantityFilled": 0,
"plan": {
"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"usageLimits": {
"softLimit": {
"quantity": 1,
"amount": 0.01
},
"hardLimit": {
"quantity": 1,
"amount": 0.01
}
}
}
],
"deliveryAddress": {
"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "Austin",
"region": "Texas",
"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": "Austin",
"region": "Texas",
"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"
},
"abandonTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "P7D",
"couponIds": [
"string"
],
"poNumber": "PO123456",
"shipping": {
"amount": 0.1,
"calculator": "manual"
},
"notes": "string",
"riskMetadata": null,
"customFields": {
"foo": "bar"
}
}

Responses

200

Order updated.

Response Schema: application/json

id	string <= 50 characters ID of the order.
orderId	string <= 50 characters ID of the order (experimental).
orderType required	string Specifies the type of order. An order may be a subscription or a one-time purchase. subscription-order
customerId required	string (CustomerId) <= 50 characters ID of the customer resource.
renewalReminderTime	string or null <date-time> Date and time when the renewal reminder event triggers.
renewalReminderNumber	integer or null Number of triggered renewal reminder events.
trialReminderTime	string or null <date-time> Date and time when the trial reminder event triggers.
trialReminderNumber	integer or null Number of triggered trial reminder events.
abandonReminderTime	string or null <date-time> Date and time when the abandon order reminder event triggers.
abandonReminderNumber	integer or null Number of abandon order reminder events that are triggered.
organizationId	string <= 50 characters Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
status	string 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"
inTrial	boolean Specifies if the subscription is currently in a trial period.
	object Trial details. To use plan defaults do not send the `trial` key, or send a `null` value.
isTrialOnly	boolean Default: false Specifies if a subscription ends after a trial period. If this value is `true`, recurring settings are ignored.
isTrialConverted	boolean Specifies if a subscription had trial conversion. Trial conversion is when at least one successful payment is made on the subscription after a trial.
	(InvoiceTimeShift (object or null)) or null 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.
	object or null Recurring interval to override plan settings. To use plan settings, set this value to `null`. To use multiple plans in one subscription, all plans must have the same recurring period length.
autopay	boolean Default: true 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.
startTime	string 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.
churnTime	string or null <date-time> Date and time when the subscription is deactivated.
renewalTime	string or null <date-time> Date and time when the subscription renews.
rebillNumber	integer or null Current billing period number.
	Array of objects Deprecated Subscription line items which queue until the next renewal, or interim, invoice is issued for the subscription.
	object Subtotal of line items in this subscription (signed value). If credits exceed debits, this value is a negative number.
paymentInstrumentId	string 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.
billingStatus	string Billing status of the most recent invoice. This value may help you to determine if you should 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"
websiteId required	string <= 50 characters ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
currency	string (CurrencyCode) = 3 characters Currency code in ISO 4217 format.
initialInvoiceId	string or null <= 50 characters ID of the initial invoice.
recentInvoiceId	string or null <= 50 characters ID of the most recently issued invoice. The invoice might not be `paid` yet.
required	Array of objects (SubscriptionOrOneTimeSaleItem) non-empty Details of items in the order.
	ContactObject (object) or null Delivery address of the order.
	ContactObject (object) or null Billing address of the order.
activationTime	string or null <date-time> Date and time when the order is activated.
voidTime	string or null <date-time> Date and time when the order is voided.
abandonTime	string 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.
delinquencyPeriod	string or null Default: 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 provided value is `null`, the order does not change state.
poNumber	string or null Purchase order number displayed on the issued invoices.
	object (Shipping) Shipping settings.
notes	string Notes for the customer displayed on the order invoice.
canceledBy	string or null Specifies who initiated the cancellation. Enum: "merchant" "customer" "rebilly" null
cancelCategory	string or null Category of the cancellation. Enum: "billing-failure" "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "never-started" "switched-plan" "other" null
cancelDescription	string or null <= 255 characters Description of the cancellation reason in free form.
revision	integer 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.
riskMetadata	object or null Risk metadata. If this value is `null`, this field uses risk metadata that is captured when creating the payment token.
billingPortalToken	string or null Customer JWT to access billing portal. This field is presented only if billing portal exists. This is an experimental field and can be changed or removed in the future.
customFields	object (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.
createdTime	string <date-time> (CreatedTime) Date and time which is set automatically when the resource is created.
updatedTime	string <date-time> (UpdatedTime) Date and time which updates automatically when the resource is updated.
	Array of objects Related links.
	object Embedded objects that are requested by the `expand` query parameter.

201

Order created.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

Response samples
200
201
401
403
404
422
1 more
application/json
subscription-order
{
"id": "sub_01HRF27SATGE4Z6PBJE6PD8328",
"orderId": "ord_01GYJPRKHBD6ZYHH897QCJMBS4",
"orderType": "subscription-order",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"renewalReminderTime": "2019-08-24T14:15:22Z",
"renewalReminderNumber": 0,
"trialReminderTime": "2019-08-24T14:15:22Z",
"trialReminderNumber": 0,
"abandonReminderTime": "2019-08-24T14:15:22Z",
"abandonReminderNumber": 0,
"organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
"status": "pending",
"inTrial": true,
"trial": {
"enabled": true,
"endTime": "2019-08-24T14:15:22Z"
},
"isTrialOnly": false,
"isTrialConverted": true,
"invoiceTimeShift": null,
"recurringInterval": null,
"autopay": true,
"startTime": null,
"churnTime": "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",
"updatedTime": "2019-08-24T14:15:22Z"
}
],
"lineItemSubtotal": {
"currency": "USD",
"amount": 49.95
},
"paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
"billingStatus": "draft",
"websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
"currency": "USD",
"initialInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
"recentInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
"items": [
{
"id": "ord_itm_0YVJ6172Q2CXW9VP7KJMKHCMMX",
"planId": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X",
"quantity": 0,
"quantityFilled": 0,
"plan": {
"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"usageLimits": {
"softLimit": {
"quantity": 1,
"amount": 0.01
},
"hardLimit": {
"quantity": 1,
"amount": 0.01
}
},
"revision": 0,
"isModified": true,
"isGrandfathered": true,
"_embedded": {
"product": { }
}
}
],
"deliveryAddress": {
"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "Austin",
"region": "Texas",
"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": "Austin",
"region": "Texas",
"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",
"abandonTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "P7D",
"poNumber": "PO123456",
"shipping": {
"amount": 0.1,
"calculator": "manual"
},
"notes": "string",
"canceledBy": "merchant",
"cancelCategory": "billing-failure",
"cancelDescription": "string",
"revision": 0,
"riskMetadata": null,
"billingPortalToken": "string",
"customFields": {
"foo": "bar"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [
{
"href": "string",
"rel": "self"
}
],
"_embedded": {
"recentInvoice": { },
"initialInvoice": { },
"customer": { },
"website": { },
"leadSource": { },
"shippingRate": { },
"paymentInstrument": { },
"upcomingInvoice": { }
}
}

Our Solutions

Products

Features

Upsert an order

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Was this section helpful?

Request Body schema: application/json
required