Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.
Example: 2
Response Schema: application/json
Array
id
string <= 50 characters
ID of the cancellation.
subscriptionId
required
string <= 50 characters
ID of the canceled subscription order.
proratedInvoiceId
string or null <= 50 characters
ID of the invoice on which the cancellation proration is calculated.
appliedInvoiceId
string or null <= 50 characters
ID of the invoice on which the cancellation fees or credits are applied.
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 Value
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 or null <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.
churnTime
string <date-time>
Date and time when the subscription is deactivated.
churnTimePolicy
required
string or null
Specifies when the subscription is to be deactivated. The churnTimePolicy takes precedence over the churnTime in request.
Enum:"null""now""at-next-renewal"
Array of objects
Items to be added to the new invoice. Proration item is generated and added automatically.
object
Subtotal of the line items added after the subscription cancellation.