Get Subscriptions

Retrieve subscription information for an account. For accounts with enterprise plans, returns a simplified response indicating enterprise status. For standard accounts, returns the full Stripe subscription object.

GET /api/subscriptions

cURL

cURL

curl --request GET \
  --url https://api.recoupable.com/api/subscriptions \
  --header 'x-api-key: <api-key>'

200

{
  "status": "success",
  "subscription": {
    "id": "<string>",
    "object": "subscription",
    "customer": "<string>",
    "currency": "<string>",
    "current_period_start": 123,
    "current_period_end": 123,
    "cancel_at_period_end": true,
    "created": 123,
    "items": {
      "object": "list",
      "data": [
        {
          "id": "<string>",
          "object": "subscription_item",
          "price": {
            "id": "<string>",
            "currency": "<string>",
            "unit_amount": 123,
            "recurring": {
              "interval_count": 123
            }
          },
          "quantity": 123
        }
      ],
      "has_more": true,
      "total_count": 123
    },
    "latest_invoice": "<string>",
    "livemode": true,
    "metadata": {}
  }
}

Authorizations

x-api-key · string · header · required

Your Recoup API key. Learn more.

Query Parameters

accountId · string<uuid> · required

The unique identifier of the account to query

Response

200

application/json

Subscription information retrieved successfully

Option 1

Option 2

Response for standard accounts with Stripe subscriptions

status · enum<string> · required

Status of the request

Available options: success

subscription · object · required

The full Stripe subscription object

Show child attributes