Subscription pause revokedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Subscription pause and order webhook request body resource.

subscriptionId
string

ID of the order.

subscriptionPauseId
string

ID of the pause.

eventType
string

Type of webhook event.

Enum: "subscription-pause-created" "subscription-pause-modified" "subscription-pause-revoked" "subscription-paused" "subscription-resumed"
object

Embedded objects.

object (Subscription)

Subscription details.

orderType
required
string

Specifies the type of order. An order may be a subscription or a one-time purchase.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

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 (OrderItem) non-empty

Item details.

id
string <= 50 characters

ID of the order.

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.

object 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.

endTime
string or null <date-time>

Date and time when the subscription ends.

renewalTime
string or null <date-time>

Date and time when the subscription renews.

rebillNumber
integer or null

Current billing period number.

Array of objects (UpcomingInvoiceItem)

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"
currency
string = 3 characters

Currency of the order.

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.

object or null

Delivery address of the order.

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.

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" … 3 more
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.

object or null (Risk metadata)

Risk metadata. If this value is null, this field uses risk metadata that is captured when creating the payment token.

customFields
object (ResourceCustomFields)
Default: {}

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.

object (SubscriptionPause)

Subscription pause details.

subscriptionId
required
string <= 50 characters

ID of the paused subscription.

id
string <= 50 characters

ID of the subscription pause.

status
string

Status of the subscription pause.

Enum: "pending" "ongoing" "revoked" "finished"
pausedBy
string
Default: "customer"

Specifies who initiated the pause.

Enum: "merchant" "customer"
description
string or null <= 255 characters

Description of the pause reason in free form.

effectiveTime
string or null <date-time>

Date and time when the service period pauses.

This time must be later than the current time. If this time is earlier then the current time, the current time is used.

If this field is omitted, this value defaults to the current time.

endTime
string or null <date-time>

Date and time when the pause ends and the subscription resumes billing.

To resume a subscription from this point in time, use the current time or an earlier time. If endTime is earlier then the current time, the current time is used. If this field is empty, the subscription is indefinitely paused.

timeRemaining
string

Amount of time between the pause end time and the renewal time in ISO-8601 durations format. By default, this value is computed as the time between the pause and the renewal.

Example: A $30 per month subscription on a 30-day month is paused on day 20 of the subscription. There are 10 unused days on the subscription. Therefore, the subscription renews in 10 days after it is resumed. The upcoming invoice does not change the amount for the invoiced period, it remains at $30. If the subscription uses a billing anchor, the renewal time after a pause shift behaves as though the renewal time is moved forward by an Order API operation, and the billing anchor is ignored for that period.

For more information, see Service period anchor, billing timing, and invoice time shift.

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 (SelfLink)

Related links.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "subscription" "pause"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "subscriptionId": "string",
  • "subscriptionPauseId": "string",
  • "eventType": "subscription-pause-created",
  • "_embedded": {
    },
  • "_links": [
    ]
}