Changes the items or quantities of an order that contains subscription items and specifies if and when to give pro rata credits. To change the items at the next renewal, use the POST /order-changes operation with applyAt set to nextRenewal.
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:
customerleadSourcewebsiteshippingRateinitialInvoicerecentInvoiceupcomingInvoicepaymentInstrumentFor more information, see Embedded resources.
How the service periods and trial state of the subscription order are managed when its items change.
The reset and retain values are deprecated. The deprecated keepTrial and ignoreRecurring are ignored unless reset or retain is used.
| Enum Value | Description |
|---|---|
| resetToRecurring | |
| retainRecurring | |
| retainTrialThenRecurring | |
| retainTrialOnly | |
| reset | Deprecated. Use |
| retain | Deprecated. Use |
Specifies whether to give a pro rata credit for the amount of time remaining between the effectiveTime and the end of the current period.
In addition, if the renewalTime is retained, by setting the renewalPolicy to retainRecurring, retainTrialThenRecurring or retainTrialOnly, a pro rata debit occurs for the amount between the effectiveTime and the renewalTime as a percentage of the normal period size.
Date from which the renewal time for reset operations and proration calculations are made. If this field is omitted, this value defaults to the current time.
Deprecated. Use the retainTrialThenRecurring or retainTrialOnly value of renewalPolicy instead.
Specifies if the active trial of the order is retained. This field is only applicable if renewalPolicy is set to the deprecated value retain.
Deprecated. Use the retainTrialOnly value of renewalPolicy instead.
Specifies if the order must ignore the recurring settings of its items. This field is only applicable if the order is trial-only and the keepTrial value is true. For more information, see Trial-only order.
curl -i -X POST \
'https://www.rebilly.com/_mock/catalog/all/subscriptions/{id}/change-items?expand=string' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"items": [
{
"plan": {
"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"quantity": 0,
"usageLimits": {
"softLimit": {
"quantity": 0
},
"hardLimit": {
"quantity": 0
},
"trialLimit": 20.725
}
}
],
"renewalPolicy": "resetToRecurring",
"prorated": true,
"effectiveTime": "2019-08-24T14:15:22Z",
"preview": false,
"keepTrial": false,
"ignoreRecurring": false
}'Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.
Number of requests still available for this rate limit. For more information, see Rate limits.
Specifies the type of order. An order may be a subscription or a one-time purchase.
Note: The order type cannot be changed after creation.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
Status of the subscription service. A subscription starts in the pending status, and becomes active when the service period begins.
Details of the trial. To use plan defaults, omit the trial key or set this value to null.
Specifies if a subscription ends after a trial period. If this value is true, recurring settings are ignored.
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.
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.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
Note: The ID of the website cannot be changed after creation.
ID of the most recently issued invoice. The invoice might not be paid yet.
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.
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.
delinquencyPeriod value is null, the order does not change state and remains active. You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.delinquencyTime parameter using the upsert an invoice API operation.If this value is not passed during order creation, an order delinquency period setting is used to calculate the value.
Sandbox recurring order retention. In the sandbox environment, a recurring order is canceled 90 days after it is created or on the start date of the policy, whichever is later. The order is not canceled if it is retained or if the organization is excluded from the policy. This property is returned in the sandbox environment only, for recurring orders. In the live environment, if the request includes this property with a value, a validation error is returned. A null value in a request does not update the property.
Category of the cancellation.
The sandbox-retention value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
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.
{ "foo": "bar" }
{ "id": "sub_01HRF27SATGE4Z6PBJE6PD8328", "orderType": "subscription-order", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "renewalReminderTime": "2019-08-24T14:15:22Z", "renewalReminderNumber": 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, "trialConversionTime": "2019-08-24T14:15:22Z", "invoiceTimeShift": { "issueTimeShift": { … }, "dueTimeShift": { … } }, "autopay": true, "startTime": null, "churnTime": "2019-08-24T14:15:22Z", "renewalTime": "2019-08-24T14:15:22Z", "currentPeriodStart": "2019-08-24T14:15:22Z", "currentPeriodEnd": "2019-08-24T14:15:22Z", "rebillNumber": 0, "lineItems": [ { … } ], "lineItemSubtotal": { "currency": "USD", "amount": 49.95 }, "mrr": 49.95, "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "billingStatus": "draft", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "currency": "USD", "initialInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT", "recentInvoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT", "items": [ { … } ], "deliveryAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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": [ … ], "emails": [ … ], "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", "sandboxRetention": { "autoCancelTime": "2027-01-10T06:00:00+00:00", "excluded": false }, "shipping": { "amount": 0.1, "calculator": "manual" }, "notes": "string", "canceledTime": "2019-08-24T14:15:22Z", "canceledBy": "merchant", "cancelCategory": "billing-failure", "cancelDescription": "string", "revision": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "billingPortalToken": "string", "customFields": { "foo": "bar" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "_embedded": { "recentInvoice": {}, "initialInvoice": {}, "customer": {}, "website": {}, "leadSource": {}, "shippingRate": {}, "paymentInstrument": {}, "upcomingInvoice": {} } }