Description of the cancellation reason in free form.
prorated
boolean
Default: false
Specifies if the customer gets a pro-rata credit for the time remaining between churnTime and subscription next renewal time.
status
string
Default: "confirmed"
Status of the subscription order.
Enum:
Description
draft
Creates a daft cancellation so that the cancellation and charge can be previewed.
confirmed
Confirms a subscription cancellation.
Sets the subscription to cancel when the churnTime is reached.
completed
Marks a subscription cancellation as completed.
This is a read-only status that is set when the churnTime is reached.
The cancellation may not be changed or deleted when the status is completed.
revoked
Revokes a subscription cancellation.
canceledTime
string <date-time>
Date and time when a subscription is cancelled.
By default, this occurs when status is confirmed, unless draft is specified.
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 (UpcomingInvoiceItem)
Items to be added to the new invoice.
Proration item is generated and added automatically.
Array
type
required
string
Type of invoice line item.
Enum:"debit""credit"
unitPriceAmount
required
number <double>
Unit price of the line item.
unitPriceCurrency
required
string (CurrencyCode) = 3 characters
Currency code in ISO 4217 format.
quantity
required
integer
Quantity of the line item.
description
string <= 1000 characters
Description of the line item.
periodStartTime
string <date-time>
Date and time when the period begins for this item.
periodEndTime
string <date-time>
Date and time when the period ends for this item.
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.
lineItemSubtotal
number
Subtotal of the line items added after the subscription cancellation.
