Retrieve cancellations

Retrieves a list of canceled subscriptions.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of cancelled subscriptions retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
subscriptionId
required
string <= 50 characters

ID of the canceled subscription order.

churnTime
required
string <date-time>

Date and time when the subscription is deactivated.

id
string <= 50 characters

ID of the cancellation.

proratedInvoiceId
string <= 50 characters

ID of the invoice on which the cancellation proration is calculated.

appliedInvoiceId
string <= 50 characters

ID of the invoice on which the cancellation fees or credits are applied.

canceledBy
string
Default: "customer"

Specifies who initiated the cancellation.

Enum: "merchant" "customer"
reason
string
Default: "other"

Reason for the cancellation.

Enum: "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "other" "billing-failure"
description
string <= 255 characters

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.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/subscription-cancellations
Request samples
$service = new Rebilly\Sdk\CoreService($client);

$cancellationsPaginator = $service->subscriptionCancellations()->getAllPaginator(
    filter: 'reason:' . Rebilly\Sdk\Model\SubscriptionCancellation::REASON_CONTRACT_EXPIRED,
);
foreach ($cancellationsPaginator as $cancellationPage) {
    printf("Cancellations page %d/%d\n", $cancellationsPaginator->key() + 1, $cancellationsPaginator->count());
    foreach ($cancellationPage as $cancellation) {
        printf(
            "Cancellation #%s (%s): %s\n",
            $cancellation->getId(),
            $cancellation->getStatus(),
            $cancellation->getSubscriptionId(),
        );
    }
}

// OR

$cancellations = $service->subscriptionCancellations()->getAll(
    filter: 'reason:' . Rebilly\Sdk\Model\SubscriptionCancellation::REASON_CONTRACT_EXPIRED,
    limit: 10,
);
foreach ($cancellations as $cancellation) {
    printf(
        "Cancellation #%s (%s): %s\n",
        $cancellation->getId(),
        $cancellation->getStatus(),
        $cancellation->getSubscriptionId(),
    );
}
Response samples
application/json
[
  • {
    }
]