True if the subscription is currently in a trial period.
object
To use plan defaults do not send the trial key, or send a null. value with it.
isTrialOnly
boolean
Default: false
Whether a subscription ends after a trial period. Recurring settings are ignored if it's true.
object or null
You can shift issue time and due time of invoices for this subscription.
This setting overrides plan settings. To use plan settings, set null.
To use multiple plans in one subscription they all must have the same billing period,
this property allows to subscribe to different plans.
object or null
The recurring interval to override plan settings. To use plan settings, set null.
To use multiple plans in one subscription they all must have the same recurring period length,
this property allows to subscribe to different plans.
autopay
boolean
Default: true
Autopay determines if a payment attempt will be automatic.
startTime
string or null <date-time>
Subscription start time. When the value is sent as null, it will use the current time. This value can't be in past more than one service period.
endTime
string <date-time>
Subscription end time.
renewalTime
string <date-time>
Subscription renewal time.
rebillNumber
integer
The current period number.
Array of objects
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, it will be a negative number.
paymentInstrumentId
string or null <= 50 characters
ID of the payment instrument to use for autopay. If not provided or inactive, the customer's default payment instrument will be used.
renewalReminderTime
string or null <date-time>
Time renewal reminder event will be triggered.
renewalReminderNumber
integer or null
Number of renewal reminder events triggered.
trialReminderTime
string or null <date-time>
Time renewal reminder event will be triggered.
trialReminderNumber
integer or null
Number of renewal reminder events triggered.
organizationId
string <= 50 characters
Organization ID.
canceledTime
string <date-time>
Subscription order canceled time.
canceledBy
string
Canceled by.
Enum:"merchant""customer""rebilly"
cancelCategory
string
Cancel category.
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"… 2 more
cancelDescription
string <= 255 characters
Cancel reason description in free form.
revision
integer
The 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 null, the value would coalesce to the risk metadata captured when creating the payment token.
customFields
object (ResourceCustomFields)
Default: {}
Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).
createdTime
string <date-time>
Order created time.
updatedTime
string <date-time>
Read-only timestamp updates when the resource is updated.
Array of Self (object) or CustomerLink (object) or InitialInvoiceLink (object) or RecentInvoiceLink (object) or WebsiteLink (object) or ApprovalUrlLink (object) non-empty
The links related to resource.
Array of RecentInvoiceEmbed (object) or InitialInvoiceEmbed (object) or CustomerEmbed (object) or WebsiteEmbed (object) or LeadSourceEmbed (object) or ShippingRateEmbed (object) or PaymentInstrumentEmbed (object) or UpcomingInvoiceEmbed (object) non-empty
Any embedded objects available that are requested by the expand querystring parameter.
object (SubscriptionPause)
subscriptionId
required
string <= 50 characters
Identifier of the paused subscription.
id
string <= 50 characters
Pause identifier.
status
string
The pause status.
Enum:"pending""ongoing""revoked""finished"
pausedBy
string
Default: "customer"
Who did the pause.
Enum:"merchant""customer"
description
string or null <= 255 characters
Pause reason description.
effectiveTime
string or null <date-time>
The date from which the service period will pause.
This time should be later than now, if it is earlier then current time is taken.
If omitted, it will default to the current time.
endTime
string or null <date-time>
The time when the pause ends and the subscription resumes its billing.
In order to resume a subscription now, use current time or past time (will default to now). Empty endTime will result in indefinitely paused subscription.
timeRemaining
string
Time period between the pause end time and the renewal time in ISO-8601 durations format. By default, it's computed as the time between the pause and the renewal.
For instance, you have a $30/month subscription and 30-day month. If you pause on day 20 of the subscription, there are 10 days unused. Therefore, the subscription would renew in 10 days after resuming. The upcoming invoice would not change the amount for invoiced period, it remains $30. There may be a billing anchor for the subscription, the renewal time after a pause shift should behave as if the renewal time moved forward with Order API (the billing anchor is ignored for that period then).
createdTime
string <date-time>
The time of resource creation (when it is posted).
updatedTime
string <date-time> (UpdatedTime)
Read-only timestamp updates when the resource is updated.
Array of objects (Self) non-empty
The links related to resource.
Array of SubscriptionLink (object) or SubscriptionPauseLink (object) non-empty
The links related to resource.
Array (non-empty)
Any of:
rel
required
string
The link type.
Value:"subscription"
href
required
string
The link URL.
Responses
2xx
Return any 2xx status to indicate that the data was received successfully.
