HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference

Update an external subscription

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

External subscription id

Body Params
external_product_reference
object
string

Id of the subscription in the external system, i.e. Apple App Store or Google Play Store.

date-time

When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.

boolean
Defaults to false

An indication of whether or not the external subscription will auto-renew at the expiration date.

string
Defaults to active

External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.

string

Identifier of the app that generated the external subscription.

integer
≥ 0
Defaults to 1

An indication of the quantity of a subscribed item's quantity.

date-time

When the external subscription was activated in the external platform.

date-time

When the external subscription expires in the external platform.

date-time

When the external subscription trial period started in the external platform.

date-time

When the external subscription trial period ends in the external platform.

boolean
Defaults to false

An indication of whether or not the external subscription was being created by a historical data import.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json