REST API endpoints

These REST API endpoints let you programmatically pull information about your mobile app subscriptions from Recurly in JSON format.

External products

Use these endpoints to view information about the external products you configured during setup.

• List all External Products by Site
• Fetch an External Product

External subscriptions

Use these endpoints to view information about external subscriptions — the Apple or Google subscriptions your customers have purchased.

• List all External Subscriptions by Site
• List all External Subscriptions by Account
• Fetch an External Subscription

Entitlements

Use this endpoint to view the entitlements granted to a specific customer (account).

• List Entitlements granted to an Account

For the complete list of endpoints specific to App Management, start at External Subscription and scroll down.

Webhooks

For key events in the subscription lifecycle, Recurly triggers a webhook so you can take follow-up action — like emailing your customer — based on the notification.

Recurly webhook payloads are lightweight by design and require a follow-up call to the REST API to get the most up-to-date information about an app store subscription. The JSON and XML examples below show a notification for a new external subscription. To get more detail, call the Fetch an External Subscription endpoint with the id provided in the webhook.

{
  "id": "s0lo0hdfmauc",
  "object_type": "external_subscription",
  "site_id": "qpem7fkwr763",
  "event_type": "created",
  "event_time": "2022-12-06T22:19:15Z"
}

<new_external_subscription_notification>
  <external_subscription>
    <id>uuid</>
  </external_subscription>
  <external_resource>
    <id></id>
    <external_object_reference></external_object_reference>
  </external_resource>
  <external_product_reference>
    <id></id>
    <reference_code></reference_code>
    <created_at></created_at>
    <updated_at></updated_at>
  </external_product_reference>
</new_external_subscription_notification>

Configuring Recurly to send webhooks

To configure webhooks for App Management, navigate to Integrations → Webhooks in Recurly and select Configure at the top right. You can either create a New Endpoint or select Options → Edit for an existing one. When configuring the endpoint, scroll to the External Subscription section and select the checkbox for any event you're interested in. The next section covers those events in detail. To learn more about Recurly webhooks in general, see the Webhooks developer documentation.

Complete list of webhook events

The table below lists every webhook Recurly sends related to mobile app subscriptions. Each one maps to a specific Apple or Google notification. For JSON and XML examples of each webhook, see the External Subscription Notifications section of the Webhooks page in the Recurly Development Hub.

Viewing triggered webhooks

All triggered webhooks are viewable in Recurly under Integrations → Webhooks. You can also reach a filtered view of triggered webhooks from the Webhooks link when viewing the details of an account or external subscription.