Subscriptions

This endpoint lets you query your Paddle subscriptions.

Subscriptions are read-only in the Refermo API; subscriptions are only added to Refermo via background API calls and Paddle webhooks. You cannot edit subscription data directly.

List subscriptions

GET https://api.refermo.co/v1/subscriptions/

Request parameters

None.

Response values

Pagination

• count (int)
  Total results for this query (including other pages of results).
• next (string)
  The URL for the next page of results, or null if there isn't one.
• previous (string)
  The URL for the previous page of results, or null if there isn't one.

Subscription data

• id (integer)
  The subscription's ID from Paddle.
• unit_price (string)
  Decimal of the susbcription's renewal cost.
• currency (string, 3 chars)
  Currency of the subscription.
• status (string)
  The current status of the subscription.
  Options: active, trialling, past_due, deleted, paused
• email (string)
  The billing email address used in the Paddle checkout flow.
• next_bill_date (date, YYYY-MM-DD)
  The next billing date for this subscription. Can be null.
• last_bill_date (date, YYYY-MM-DD)
  The last billing date for this subscription. Can be null.
• plan (dictionary)
  A plan object.

Example response

HTTP 200 OK
{
  "count": 24,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 7849272,
      "unit_price": "59.00",
      "currency": "USD",
      "status": "active",
      "email": "sub@gmail.com",
      "next_bill_date": "2021-11-20",
      "last_bill_date": "2021-10-20",
      "plan": {
        "id": 823873,
        "name": "Pro monthly",
        "amount": "59.00",
        "currency": "USD",
        "interval": "year",
        "frequency": 1
      }
    },

Filters

List subscriptions with a specific status

Use the status query parameter with a valid status value (active, trialling, past_due, deleted, paused).

GET https://api.refermo.co/v1/subscriptions/?status=active