List Subscriptions

Transactions

Retrieve a list of subscriptions with support for filtering by status, customer, plan, and pagination options.

GEThttps://api.efundpay.com/v4/subscriptions

This endpoint requires the subscriptions.read scope.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header in the format `Bearer <token>`, where `<token>` is your authentication token.

Headers

x-merchant-account-idstringrequired

Merchant account ID for this request.

Examples:""default""

Path Parameters

limitinteger

Maximum number of items to return.

Default:20

Range:1 <= x <= 100

Examples:"20"

cursorstring

Cursor pointing to the page of results to return.

Examples:"0"

statusstring

Filter by subscription status.

Examples:"active""failed""cancelled""past_due"

customer_idstring

Filter by customer ID.

Examples:"cus_abc123"

Response

application/json

Successful Response

objectstringrequired

Object type, always "list".

Examples:"list"

itemsSubscription · object[]required

List of returned subscription objects.

limitintegerrequired

Number of items on this page.

Examples:"20"

next_cursorstring | null

Cursor pointing to the next page of items.

Examples:"2"

previous_cursorstring | null

Cursor pointing to the previous page of items.

Examples:"1"

curl --request GET \
  --url https://api.efundpay.com/v4/subscriptions?status=active&limit=20 \
  --header 'Authorization: Bearer <token>' \
  --header 'x-merchant-account-id: <x-merchant-account-id>'

{
  "items": [
    {
      "id": "sub_1234567890abcdef",
      "object": "subscription",
      "created": "2024-01-15T10:30:00Z",
      "status": "active",
      "customer": {
        "id": "cus_abc123",
        "display_name": "John Doe",
        "external_identifier": "customer-12345",
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "john@example.com",
        "phone_number": "+1234567890",
        "account_number": "123456789"
      },
      "plan": {
        "name": "Basic Monthly",
        "currency": "USD",
        "amount": 1000,
        "interval": "month",
        "trial_period_days": 14,
        "billing_cycle_anchor": "immediate"
      },
      "payment_method": {
        "token_id": "tok_a1b2c3d4",
        "type": "card",
        "card": {
          "number": "4111111111111111",
          "expiration_date": "12/27",
          "security_code": "123"
        }
      },
      "current_period_start": "2024-01-15T10:30:00Z",
      "current_period_end": "2024-02-15T10:30:00Z",
      "next_billing_date": "2024-02-15"
    },
    {
      "id": "sub_abcdef1234567890",
      "object": "subscription",
      "created": "2024-01-10T08:15:00Z",
      "status": "active",
      "customer": {
        "id": "cus_def456",
        "display_name": "Jane Smith",
        "external_identifier": "customer-67890",
        "first_name": "Jane",
        "last_name": "Smith",
        "email_address": "jane@example.com",
        "phone_number": "+1987654321",
        "account_number": "987654321"
      },
      "plan": {
        "name": "Premium Yearly",
        "currency": "USD",
        "amount": 9999,
        "interval": "year",
        "trial_period_days": 30,
        "billing_cycle_anchor": "first_of_month"
      },
      "payment_method": {
        "token_id": "tok_b2c3d4e5",
        "type": "card",
        "card": {
          "number": "5555555555554444",
          "expiration_date": "11/26",
          "security_code": "456"
        }
      },
      "current_period_start": "2024-01-10T08:15:00Z",
      "current_period_end": "2025-01-10T08:15:00Z",
      "next_billing_date": "2025-01-10"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}