GET /api/v1/subscriptions

List all of your subscriptions, ordered chronologically, most recent payment first.

Request

$ curl -X GET https://api.payhere.co/api/v1/subscriptions?page=1&per_page=50 \
       -H "Accept: application/json" \
       -H "Authorization: Bearer ${api_key_here}"

require "http"
require "json"

resp = HTTP.auth("Bearer #{api_key_here}")
           .get(
              "https://api.payhere.co/api/v1/subscriptions",
              page: 1,
              per_page: 50
            )

parsed = JSON.parse(resp.body)

Params

  • page - Page number
  • per_page - Records per page, default 20, max 100.

Response

{
  "data": [
    {
      "id": 173524457,
      "customer_id": 989899294,
      "last_charged": "2018-01-03T00:00:00.000Z",
      "next_charge_at": "2018-02-03T00:00:00.000Z",
      "status": "active",
      "stripe_subscription_id": "2e72dabd",
      "stripe_plan_id": "void_pro_sub_1",
      "billing_interval": "month",
      "membership_plan_id": 372786875,
      "provider": "stripe",
      "metadata": {},
      "billing_interval_count": 1,
      "min_billing_cycles": null,
      "created_at": "2018-01-03T00:00:00.000Z",
      "updated_at": "2018-01-03T00:00:00.000Z",
      "type": "subscriptions",
      "customer": {
        "id": 989899294,
        "name": "Geoff Williams",
        "email": "g.williams01@example.org",
        "ip_address": null,
        "location": {},
        "created_at": "2019-03-04T17:06:36.240Z",
        "updated_at": "2019-03-04T17:06:36.240Z",
        "type": "customers"
      },
      "plan": {
        "id": 20,
        "payment_type": "recurring",
        "name": "Pro Plan",
        "description": "",
        "price": 15,
        "price_in_cents": 1500,
        "currency": "gbp",
        "slug": "pro-plan",
        "billing_interval": "month",
        "billing_interval_count": 1,
        "hidden": false,
        "min_billing_cycles": null,
        "billing_day": null,
        "limited_qty": false,
        "qty": 0,
        "cancel_after": null,
        "success_url": "",
        "trial_period_days": null,
        "created_at": "2019-04-19T09:02:45.846Z",
        "updated_at": "2019-04-27T12:05:38.223Z",
        "type": "plans"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

Errors

  • 400 Bad request
  • 401 Unauthorized
← POST /GET /:id →